shipcel 0.0.0-stage → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +111 -2
- package/dist/shipcel.js +7142 -0
- package/package.json +36 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,112 @@
|
|
|
1
|
-
#
|
|
1
|
+
# shipcel
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Set up, build and deploy to your own Cloudflare account through [Shipcel](https://shipcel.com), from your terminal or CI. The commands follow Vercel's CLI: `shipcel login` signs you in, `shipcel` builds this project and deploys a preview, `shipcel --prod` deploys to production, and `ls`, `inspect`, `promote`, `rollback`, `logs`, `env`, `domains`, `link` and `git connect` work the way you'd expect.
|
|
4
|
+
|
|
5
|
+
Install it from npm (it needs Node.js 20 or later), or run it without installing with `npx shipcel`:
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g shipcel
|
|
9
|
+
shipcel login # once: GitHub, then Cloudflare
|
|
10
|
+
cd my-site
|
|
11
|
+
shipcel # build it here and deploy it
|
|
12
|
+
shipcel --prod # later: deploy to production
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
A Shipcel you run yourself serves its own CLI at `/cli/shipcel.tgz`: install it from there, and sign in once with `shipcel login --url <its address>`. Its dashboard's **API & CLI** page shows these commands with its address.
|
|
16
|
+
|
|
17
|
+
`login` shows a code and opens one page in your browser. There you sign in with GitHub (if that browser isn't signed in yet), check the code and approve, and connect Cloudflare if the workspace hasn't yet; each sign-in comes back to the same page, and the CLI carries on by itself. It keeps a token in `~/.config/shipcel/config.json` (readable only by you).
|
|
18
|
+
|
|
19
|
+
In a project's folder, `shipcel` recognises the framework, builds on your computer and deploys the result, so nothing has to be set up in Cloudflare. A site (Vite, Create React App, Vue CLI, Astro, Gatsby, Docusaurus, VitePress, Eleventy, Hugo, Jekyll and others) is uploaded as files. An app with code or bindings (Next.js on OpenNext, SvelteKit, Astro with its adapter, or any Worker with a `wrangler.jsonc`, with its D1, KV and R2 bindings) is deployed by Wrangler, which the CLI runs for you: for that one deploy Wrangler reaches your Cloudflare account through Shipcel with a token that is good for nothing else. A framework app that has no Cloudflare adapter yet gets it, and its `wrangler.jsonc`, added on the way (the CLI asks once; `--yes` in scripts). The first time, it shows what it detected and lets you change it; `--build-command` and `--output` override it, `shipcel build` builds without deploying and `--prebuilt` skips the build.
|
|
20
|
+
|
|
21
|
+
A new app's first deploy goes to production, as on Vercel, at its free `https://<app>.<subdomain>.workers.dev` address. After that `shipcel` deploys a preview and `--prod` deploys to production; `--target preview` or `--target production` says which either way.
|
|
22
|
+
|
|
23
|
+
`shipcel git connect` makes Cloudflare build and deploy every push to the folder's GitHub repository instead. Cloudflare's builds need its own GitHub app and a build token, once per account: the CLI checks both, opens the page for whichever is missing, and continues when it's done.
|
|
24
|
+
|
|
25
|
+
## Previews and production
|
|
26
|
+
|
|
27
|
+
Like Vercel's preview deployments, `shipcel deploy` without `--prod` uploads a new version with its own address, `https://<version>-<app>.<subdomain>.workers.dev`, while production keeps serving the current version. Then:
|
|
28
|
+
|
|
29
|
+
- `shipcel promote <version|preview url>` makes that version production (and publishes the app if it wasn't public yet);
|
|
30
|
+
- `shipcel rollback` sends production back to the most recent earlier version that served production (previews never did), or `shipcel rollback <version>` to a given one. Database changes are not undone;
|
|
31
|
+
- `shipcel ls` lists the 25 newest versions with their status and preview addresses, and `shipcel inspect <version|url>` shows one.
|
|
32
|
+
|
|
33
|
+
Under the hood these are Cloudflare Worker versions and deployments in your account: a preview is a version uploaded without deploying it (as `wrangler versions upload` does), and production is the deployment that sends it all traffic.
|
|
34
|
+
|
|
35
|
+
## What it deploys
|
|
36
|
+
|
|
37
|
+
A folder of built static files, as your build tool leaves it (`dist`, `build`, `out`…): the one the CLI just built, or the one you name. Shipcel uploads only files Cloudflare doesn't already have, so later deploys are quick. In the folder:
|
|
38
|
+
|
|
39
|
+
- `_worker.js` (optional): an ES module that handles requests no file matches. Without it no code runs: Cloudflare serves the files directly, and static file requests are free. Secrets set with `shipcel env add` reach it as `env.NAME`, and stay across deploys.
|
|
40
|
+
- `_redirects` and `_headers` work like on other static hosts (Cloudflare's [static assets rules](https://developers.cloudflare.com/workers/static-assets/redirects/)).
|
|
41
|
+
- `404.html` is used for unknown paths. Without one, a single-page app's unknown paths go to `index.html` (the framework says so; for a folder you upload, a single `index.html` does); `--no-spa` turns that off.
|
|
42
|
+
- `.shipcelignore` lists files to leave out (`*.map`, `/drafts/`, `**/tmp/**`). `node_modules`, `.git` and hidden files are always left out, except `/.well-known`.
|
|
43
|
+
|
|
44
|
+
Containers, Python Workers with packages, routes and queues deploy from GitHub instead: `shipcel git connect`, or the Shipcel dashboard. A framework that has no Cloudflare adapter yet is offered Wrangler's own setup first.
|
|
45
|
+
|
|
46
|
+
## Commands
|
|
47
|
+
|
|
48
|
+
| Shipcel | Vercel | What it does |
|
|
49
|
+
| --------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
50
|
+
| `shipcel [deploy] [folder]` | `vercel [deploy]` | Build this project, or take a built folder, and deploy it: a new app to production, later deploys as previews (`--project`, `--name`, `--target`, `--prebuilt`, `--build-command`, `--output`, `--spa`) |
|
|
51
|
+
| `shipcel deploy --prod` | `vercel --prod` | Deploy to production and publish its address |
|
|
52
|
+
| `shipcel build` | `vercel build` | Build without deploying; `shipcel deploy --prebuilt` deploys the result |
|
|
53
|
+
| `shipcel git connect` | `vercel git connect` | Have Cloudflare build and deploy every push to this folder's GitHub repository |
|
|
54
|
+
| `shipcel promote <version\|url>` | `vercel promote` | Make a version (such as a preview) production |
|
|
55
|
+
| `shipcel rollback [version\|url]` | `vercel rollback` | Send production back to the previous production version, or the one given |
|
|
56
|
+
| `shipcel redeploy` | `vercel redeploy` | Build a GitHub project's production branch again |
|
|
57
|
+
| `shipcel list` / `ls [project]` | `vercel ls` | Versions, newest first, with their status and preview addresses |
|
|
58
|
+
| `shipcel inspect <version\|url>` | `vercel inspect` | One version's details |
|
|
59
|
+
| `shipcel logs [--since 2h] [--errors] [--follow]` | `vercel logs` | Requests and errors from Workers Logs |
|
|
60
|
+
| `shipcel open [--app]` | `vercel open` | The project in the dashboard, or the app itself |
|
|
61
|
+
| `shipcel publish` / `unpublish` | – | Turn the app's public `workers.dev` address on or off |
|
|
62
|
+
| `shipcel init [kit] [folder]` | `vercel init` | Create a project from a starter kit and write its files to a new folder |
|
|
63
|
+
| `shipcel link [--project <name>]` | `vercel link` | Link this folder to a project |
|
|
64
|
+
| `shipcel project ls\|add\|rm\|inspect` | `vercel project` | Manage projects (`shipcel projects` lists them too) |
|
|
65
|
+
| `shipcel remove` / `rm <name>` | `vercel remove` | Remove a project from Shipcel; its Worker and data stay in your Cloudflare account |
|
|
66
|
+
| `shipcel env ls\|add <NAME>\|rm <NAME>` | `vercel env` | The app's secrets; `--build` for a GitHub project's build variables |
|
|
67
|
+
| `shipcel domains ls\|add <host>\|rm <host>` | `vercel domains` | Custom domains in your Cloudflare zones |
|
|
68
|
+
| `shipcel activity` | `vercel activity` | What changed in your workspace recently |
|
|
69
|
+
| `shipcel dev` | `vercel dev` | Run the project on your computer: its dev script, or Wrangler's local runtime |
|
|
70
|
+
| `shipcel rolling-release start\|approve\|complete\|abort` | `vercel rolling-release` | Move production to a version a share at a time |
|
|
71
|
+
| `shipcel crons ls\|add\|rm` | `vercel crons` | Cron schedules for the app's `scheduled()` handler |
|
|
72
|
+
| `shipcel metrics [--since 7d]` | `vercel metrics` | Requests, errors and CPU time |
|
|
73
|
+
| `shipcel curl [path]`, `httpstat [path]` | same | Request the app or one version (`--deployment`), or time a request |
|
|
74
|
+
| `shipcel env pull [file]`, `shipcel pull` | same | The names of the app's variables, into `.env.local` or `.dev.vars`; secret values are never readable |
|
|
75
|
+
| `shipcel alias ls\|set\|rm` | `vercel alias` | The same as `domains`: a custom domain serves production |
|
|
76
|
+
| `shipcel mcp [--write]`, `shipcel agent init` | same | Connect an AI agent to Shipcel; deploy notes in `AGENTS.md` |
|
|
77
|
+
| `shipcel api <path>` | `vercel api` | Call Shipcel's API as you |
|
|
78
|
+
| `shipcel upgrade`, `switch`, `telemetry` | same | Install the latest CLI for this Shipcel; sign in to another workspace; no telemetry is sent |
|
|
79
|
+
| `shipcel login` / `logout` / `whoami` | same | Sign in with GitHub and connect Cloudflare through the browser, sign out, show who you are |
|
|
80
|
+
| `shipcel help [command]`, `--version` | same | Help for one command; the CLI's version |
|
|
81
|
+
|
|
82
|
+
Options that work everywhere: `--cwd <folder>`, `--token <token>`, `--url <address>`, `--yes` (`-y`), `--json`, `--help` (`-h`), `--version` (`-v`). A command that changes something asks first in a terminal; in scripts it needs `--yes`.
|
|
83
|
+
|
|
84
|
+
What isn't there, and why: `env pull` (Cloudflare never returns secret values; keep local ones in `.dev.vars`), `dev` (run `npx wrangler dev` in a project with a Wrangler configuration), `teams`/`switch` (a token belongs to one workspace: sign in again to use another), and Vercel-only products (Blob, Edge Config, Flags, Firewall). For storage and databases, use the dashboard's Manage tab.
|
|
85
|
+
|
|
86
|
+
## Secrets
|
|
87
|
+
|
|
88
|
+
```sh
|
|
89
|
+
shipcel env add API_KEY # asks for the value without showing it
|
|
90
|
+
printf %s "$API_KEY" | shipcel env add API_KEY # or reads it from standard input
|
|
91
|
+
shipcel env ls # names only
|
|
92
|
+
shipcel env rm API_KEY --yes
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
A secret goes straight to Cloudflare as a Worker secret; Shipcel never stores it. Setting one deploys it with the current code, like `wrangler secret put`.
|
|
96
|
+
|
|
97
|
+
## In CI
|
|
98
|
+
|
|
99
|
+
Create a token under **API & CLI** in the dashboard and set it as a secret:
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
SHIPCEL_URL=https://shipcel.com SHIPCEL_TOKEN=cc_pat_… \
|
|
103
|
+
npx --yes shipcel deploy ./dist --prod --project my-site
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
A token always comes with its Shipcel's address, so one for a Shipcel you run yourself never goes anywhere else: set `SHIPCEL_URL` to that address, and take the CLI from there.
|
|
107
|
+
|
|
108
|
+
A token acts as you in your workspace. It can deploy and manage projects, but it can't create tokens, connect accounts, turn Free-only off, protect previews or add webhooks.
|
|
109
|
+
|
|
110
|
+
## Development
|
|
111
|
+
|
|
112
|
+
The source is TypeScript in `src/` (`cli.ts` the commands, `site.ts` what a project builds, `git.ts` reading Git remotes, `main.ts` the process wiring; framework presets are shared with the server in `shared/site-presets.ts`); `npm run cli:build` (from the repository root) bundles it into `dist/shipcel.js` with no runtime dependencies and packs it as `public/cli/shipcel.tgz`, which Shipcel serves at `/cli/shipcel.tgz`. `npm run cli:build -- --check` fails when either is stale. The same package is published to npm, by hand or with `.github/workflows/publish-cli.yml`. Tests are in `tests/cli.test.ts`.
|