@@ -28,7 +28,7 @@ structured usage error; explicit `--help` always renders human help.
2828| Area | Commands |
2929| ---| ---|
3030| Prepare | ` setup ` , ` init ` , ` validate ` , ` doctor ` |
31- | Lifecycle | ` plan ` , ` up ` , ` start ` , ` stop ` , ` restart ` , ` reload ` , ` recreate ` , ` status ` , ` destroy ` |
31+ | Lifecycle | ` plan ` , ` up ` , ` start ` , ` stop ` , ` restart ` , ` reload ` , ` recreate ` , ` status ` , ` destroy ` , ` purge ` |
3232| Access | ` ssh ` , ` exec ` , ` logs ` , ` provision ` , ` ssh-config ` , ` hosts install/uninstall ` |
3333| Images | ` update ` , ` image list/info/pull/import/sync/prune/reset ` , ` repo scan/build/verify ` |
3434| Host network | ` network status/install/uninstall ` |
@@ -49,9 +49,11 @@ Frequently used commands have scoped aliases:
4949| ` ssh-config ` | ` sc ` | ` image ` | ` images ` , ` im ` |
5050| ` doctor ` | ` dt ` | ` network ` | ` n ` , ` net ` |
5151| ` exec ` / ` logs ` | ` ex ` / ` l ` | ` version ` | ` ver ` |
52+ | ` purge ` | ` rm ` | | |
5253
5354` up ` , ` ssh ` , ` init ` , ` start ` , ` stop ` , ` restart ` , ` reload ` , ` provision ` ,
54- ` hosts ` , and ` completion ` have no aliases. Inside a namespace, ` hosts ` and
55+ ` hosts ` , and ` completion ` have no aliases. ` purge ` uses ` rm ` as its explicit
56+ whole-deployment disposal alias. Inside a namespace, ` hosts ` and
5557` network ` use ` i ` /` u ` for install/uninstall; ` network status ` uses ` st ` ; and
5658` image ` maps ` list=ls ` , ` info=in ` , ` pull=p ` , ` prune=pr ` , ` sync=sy ` ,
5759and ` import=i ` . ` image reset ` keeps ` reset-manifest ` as a compatibility alias.
@@ -75,7 +77,8 @@ is command-scoped; `-f` is deliberately not a global flag:
7577| ` -v ` , ` --verbose ` | bounded diagnostics on stderr |
7678| ` -c ` , ` --cidr ` | select the RFC1918 ` /24 ` for generated ` init ` /` setup ` templates or host-network inspection/install |
7779| ` -f ` , ` --file ` | select an Inventory for commands that read desired state |
78- | ` -r ` , ` --repo ` | choose an image/artifact repository for commands that resolve downloads |
80+ | ` -r ` , ` --repo ` | choose an image/artifact repository; overrides ` --mirror ` and ` FARROW_REPO ` |
81+ | ` --mirror ` | use the China official repository for setup, Catalog, and image-resolving lifecycle commands |
7982| ` -m ` , ` --mode ` | select ` host ` or ` shared ` where the command exposes the macOS network mode |
8083| ` -d ` , ` --dry-run ` | show a setup/image plan without changing state |
8184| ` -y ` , ` --yes ` | apply a displayed host/setup/image plan |
@@ -85,12 +88,20 @@ is command-scoped; `-f` is deliberately not a global flag:
8588| ` --delete-persistent ` | during whole destroy, also delete retained data disks; invalid with node selectors |
8689| ` --purge ` | whole-deployment disposal: delete disks, keys, and deployment state; keep images |
8790
88- Rare or safety-widening controls such as ` --force ` , ` --rollback ` , ` --remove ` ,
89- ` --allow-downgrade ` , ` --sudo ` , ` --delete-persistent ` , and ` --purge ` are
91+ Rare, selection, or safety-widening controls such as ` --mirror ` , ` --force ` ,
92+ ` --rollback ` , ` --remove ` , ` --allow-downgrade ` , ` --sudo ` ,
93+ ` --delete-persistent ` , and ` --purge ` are
9094long-only. On commands that read an Inventory, ` -f ` always selects a file;
9195` logs -f ` retains the conventional ` --follow ` . ` -n ` always means ` --no-wait ` ,
9296and ` -d ` always means a dry run.
9397
98+ ` farrow purge ` (alias ` farrow rm ` ) is the no-confirmation shortcut for
99+ ` farrow destroy --force --purge ` . It accepts no nodes or Inventory, removes the
100+ complete deployment plus persistent disks, keys, state, and the default SSH
101+ fragment, and keeps images and the host network. With no deployment it succeeds
102+ without changing the image cache. Missing state never authorizes deletion of
103+ residual node artifacts whose identity cannot be proven.
104+
94105If a failing command has not already emitted a richer typed result, structured
95106mode writes one object containing ` error ` and ` message ` before returning the
96107documented non-zero exit code. Existing typed failure results are never followed
0 commit comments