flypod 0.14.0 → 0.16.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/README.md +73 -13
- package/dist/bin/deploy.js +595 -244
- package/dist/{cli-xrnr1hed.js → cli-8h0vc7g2.js} +145 -16
- package/dist/src/cli/commands.d.ts +14 -0
- package/dist/src/cli/errors.d.ts +1 -0
- package/dist/src/cli/limits.d.ts +7 -0
- package/dist/src/cli/projects.d.ts +25 -1
- package/dist/src/cli/receipt.d.ts +10 -0
- package/dist/src/cli.d.ts +38 -2
- package/dist/src/cli.js +7 -1
- package/dist/src/ingest-error.d.ts +23 -0
- package/dist/src/ui.d.ts +27 -0
- package/dist/src/upload-limits.d.ts +25 -0
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -138,6 +138,7 @@ flypod install skill --global # user level: ~/.claude, ~/.agents
|
|
|
138
138
|
flypod install skill --list # where each target would go
|
|
139
139
|
flypod install skill --dry-run # print the planned paths, write nothing
|
|
140
140
|
flypod install skill --all # skip the picker, write everything
|
|
141
|
+
flypod install skill --yes # same as --all (-y): never prompt, for scripts
|
|
141
142
|
```
|
|
142
143
|
|
|
143
144
|
`--cursor`, `--codex`, `--copilot`, `--gemini`, `--windsurf`, `--cline`, and
|
|
@@ -203,6 +204,25 @@ something to look at, and `✗` with the fix underneath when it did not work.
|
|
|
203
204
|
made, use [`flypod update`](#how-do-i-ship-a-change-to-the-same-site) — not
|
|
204
205
|
`flypod` again.
|
|
205
206
|
|
|
207
|
+
### What gets uploaded
|
|
208
|
+
|
|
209
|
+
Everything in the folder, except what no website serves on purpose: `.git`,
|
|
210
|
+
`.hg`, `.svn`, `node_modules`, `.DS_Store`, `Thumbs.db`, `.env` and `.env.*`,
|
|
211
|
+
at any depth. Other dotfiles are kept — `.well-known/`, `.nojekyll` and
|
|
212
|
+
`_headers` are ordinary build output. To leave out more, put gitignore-style
|
|
213
|
+
patterns in a `.flypodignore` in the folder (`*.map`, `drafts/`, `/raw`, `**`,
|
|
214
|
+
and `!` to re-include); the file itself is never uploaded. Whatever was left
|
|
215
|
+
out is listed after the deploy, and in `skipped` under `--json`.
|
|
216
|
+
|
|
217
|
+
A link to a directory is followed when it points inside the folder, and left
|
|
218
|
+
out (and listed) when it points outside it, loops, or points nowhere.
|
|
219
|
+
|
|
220
|
+
On flypod.dev a deploy may hold at most 200 files and 10 MB of files (12 MB
|
|
221
|
+
as an upload: the archive is stored, not compressed, so it is the files plus
|
|
222
|
+
a few bytes each). flypod checks before uploading and fails with `too_large`,
|
|
223
|
+
naming the limit and the largest files. A self-hosted server sets its own
|
|
224
|
+
limits (`UPLOAD_MAX_*`) and enforces them itself.
|
|
225
|
+
|
|
206
226
|
To skip the package runner:
|
|
207
227
|
|
|
208
228
|
```sh
|
|
@@ -359,6 +379,19 @@ and client-side routing works with nothing configured.
|
|
|
359
379
|
For an agent, that pair is a closed loop — deploy, read the receipt, apply the
|
|
360
380
|
`fix_recipe`, `flypod update` — without a human in it.
|
|
361
381
|
|
|
382
|
+
`skipped`, present only when something was left out, lists each path flypod
|
|
383
|
+
did not upload, with a `reason`: `default` (secrets, version control,
|
|
384
|
+
dependencies — see [What gets uploaded](#what-gets-uploaded)), `flypodignore`,
|
|
385
|
+
or `symlink_outside` / `symlink_loop` / `broken_symlink`. `flypod update`
|
|
386
|
+
carries it too.
|
|
387
|
+
|
|
388
|
+
With `--comments`, the receipt has `comments_enabled` and `comments_mode` (the
|
|
389
|
+
mode applied). An anonymous deploy cannot turn comments on, so it also has
|
|
390
|
+
`comments_skipped: "not_signed_in"` and a `comments_fix` naming the commands:
|
|
391
|
+
`flypod login`, then `flypod comments enable`. A `--mode` other than
|
|
392
|
+
`anonymous`, `passcode` or `approved` is a usage error before anything is
|
|
393
|
+
uploaded.
|
|
394
|
+
|
|
362
395
|
`expires_at` is epoch **milliseconds** while the site is temporary, and `null`
|
|
363
396
|
once it's yours. `next` holds the literal commands for what comes after;
|
|
364
397
|
`next.update` is the one that matters, because running `flypod` again makes a
|
|
@@ -384,14 +417,25 @@ unconditionally:
|
|
|
384
417
|
```
|
|
385
418
|
|
|
386
419
|
Branch on `code` — it is stable; `error` is prose and may change; `fix`, when
|
|
387
|
-
present, is the literal next step. The codes: `no_build_dir
|
|
388
|
-
|
|
389
|
-
`
|
|
390
|
-
`
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
`
|
|
420
|
+
present, is the literal next step. The codes: `no_build_dir` (no build folder
|
|
421
|
+
found, or the path given does not exist), `no_files`, `no_site`,
|
|
422
|
+
`not_signed_in`, `unauthorized`, `token_rejected`, `site_gone`,
|
|
423
|
+
`invalid_upload`, `too_large` (checked before uploading too, naming the limit
|
|
424
|
+
and the largest files), `blocked`, `challenge_required`, `rate_limited`,
|
|
425
|
+
`server_error`, `network` (the server could not be reached, or a proxy or
|
|
426
|
+
firewall in between refused the request), `usage` (bad arguments, including a value flag with
|
|
427
|
+
no value: `--site needs a value`), `unknown_flag` (naming the closest real flag
|
|
428
|
+
when there is one), `unknown_command` (a verb that does not exist — a bare word
|
|
429
|
+
within two letters of one, like `flypod verisons`, is this rather than a
|
|
430
|
+
deploy, with the right command as `fix` — or a `flypod comments` verb that
|
|
431
|
+
does not exist), `no_such_version` (nothing to roll back to), `no_token`
|
|
432
|
+
(`flypod token` on a site this machine holds no manage token for),
|
|
433
|
+
`already_claimed`, `not_found`, `bad_request` (any other 4xx), `unexpected`,
|
|
434
|
+
and the login codes below.
|
|
435
|
+
|
|
436
|
+
**Help is never a failure.** `--help` (or `-h`) on any verb prints the usage on
|
|
437
|
+
stdout, exits 0, and never runs the verb or touches the network. With `--json`
|
|
438
|
+
it is one line of JSON instead: `{"ok": true, "help": "<the usage text>"}`.
|
|
395
439
|
The [exit code](#exit-codes) follows the code, never the verb.
|
|
396
440
|
|
|
397
441
|
A credential that is sent but not accepted (an expired `FLYPOD_TOKEN`, say)
|
|
@@ -576,9 +620,9 @@ Deploy flags:
|
|
|
576
620
|
| `--verbose` | More of the same receipt. In a terminal: the rollback and history commands, plus the site id, version id and source folder. With `--json`: also tokens, counts, timing. Also on `flypod update` |
|
|
577
621
|
| `-q`, `--quiet` | Print only the URL on stdout, and nothing else |
|
|
578
622
|
| `--timeline`, `--no-timeline` | Turn History on or off: the chip on the site's pages, an address per version, and the compare page. Also on `flypod update`, and on `flypod versions` to switch it without deploying. `--history` is the same flag |
|
|
579
|
-
| `--comments` | Enable comments on the new site (requires being signed in) |
|
|
580
|
-
| `--mode <mode>` | With `--comments`: `anonymous` (default), `passcode`, or `approved
|
|
581
|
-
| `-h`, `--help` | Show usage |
|
|
623
|
+
| `--comments` | Enable comments on the new site (requires being signed in; otherwise the receipt says `comments_skipped`) |
|
|
624
|
+
| `--mode <mode>` | With `--comments`: `anonymous` (default), `passcode`, or `approved`. Anything else is a usage error |
|
|
625
|
+
| `-h`, `--help` | Show usage on stdout (JSON under `--json`); never runs the command |
|
|
582
626
|
| `-v`, `--version` | Print the version |
|
|
583
627
|
|
|
584
628
|
Targeting flags, on `update` / `versions` / `rollback` / `forget`:
|
|
@@ -698,7 +742,7 @@ one; signing in turns temporary sites into yours.
|
|
|
698
742
|
|
|
699
743
|
```sh
|
|
700
744
|
flypod login # approve this CLI in your browser (device flow)
|
|
701
|
-
flypod login --token <t> #
|
|
745
|
+
flypod login --token <t> # check a session token, then save it; no browser
|
|
702
746
|
flypod list # your sites (JSON on stdout)
|
|
703
747
|
flypod claim <id> <token> # attach one anonymous deploy by its claim token
|
|
704
748
|
flypod logout # forget the local session
|
|
@@ -708,6 +752,15 @@ flypod logout # forget the local session
|
|
|
708
752
|
machine still remembers, and it makes every *subsequent* deploy yours from the
|
|
709
753
|
start — no expiry, no `claim_token`, listed under `flypod list`.
|
|
710
754
|
|
|
755
|
+
`flypod login --token <t>` asks the server before saving anything: a token it
|
|
756
|
+
does not accept fails with `token_rejected` (exit 3), and a server it cannot
|
|
757
|
+
reach with `network` (exit 4). Nothing is saved in either case.
|
|
758
|
+
|
|
759
|
+
"Every site this machine remembers" includes a site whose folder you have
|
|
760
|
+
since deployed a different site from: running `flypod` twice in one folder
|
|
761
|
+
points the folder at the new site, and flypod keeps the first one's record so
|
|
762
|
+
`flypod login` still keeps it and `--site <id>` still reaches it.
|
|
763
|
+
|
|
711
764
|
## What does flypod write to disk?
|
|
712
765
|
|
|
713
766
|
Two files, both in the CLI's own config directory — **never in your repo**:
|
|
@@ -783,7 +836,14 @@ site again, you have to keep it. Treat it and `claim_token` as secrets.
|
|
|
783
836
|
### `collectDist(path)`
|
|
784
837
|
|
|
785
838
|
Reads a directory recursively — or a single file — into a
|
|
786
|
-
`Record<string, Uint8Array>` for `deploySite`.
|
|
839
|
+
`Record<string, Uint8Array>` for `deploySite`. It leaves out the same paths the
|
|
840
|
+
CLI does (see [What gets uploaded](#what-gets-uploaded)), including those in a
|
|
841
|
+
`.flypodignore`.
|
|
842
|
+
|
|
843
|
+
### `collectFiles(path)`
|
|
844
|
+
|
|
845
|
+
The same, plus a report: `{ files, skipped }`, where `skipped` is
|
|
846
|
+
`Array<{ path, reason }>` — what was left out and why.
|
|
787
847
|
|
|
788
848
|
### `resolveDeployDir({ cwd?, explicit? })`
|
|
789
849
|
|