detached 83e8199

docs(cli): update index for v2.30.0

Add preview, volumes to management commands table. Sort commands
alphabetically. Add auth login/status/show-token/logout and preview/
volumes to quick reference. Remove dead password hash example.
commit
83e8199528dffffd708e280fc51917246246e240
author
brice · · 2026-03-28 07:42 UTC
parent
3ee801c
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
1 file · +27 -12
M docs/cli/index.md +27 -12
@@ -23,23 +23,25 @@ Management commands run locally through in-process services by default. Add `--r
2323
2424 | Command | Description | Documentation |
2525 |---------|-------------|---------------|
26-| `gordon routes` | Manage routes | [routes](./routes.md) |
2726 | `gordon attachments` | Manage container attachments | [attachments](./attachments.md) |
28-| `gordon secrets` | Manage secrets | [secrets](./secrets.md) |
29-| `gordon deploy` | Manually deploy or redeploy a route | [serve](./serve.md#gordon-deploy) |
30-| `gordon restart` | Restart a running container | [restart](./restart.md) |
27+| `gordon autoroute` | Manage auto-route domain allowlist | [autoroute](./autoroute.md) |
28+| `gordon backups` | Manage database backups | [backup](./backup.md) |
3129 | `gordon bootstrap` | Configure a route, attachments, and secrets for an app | [bootstrap](./bootstrap.md) |
30+| `gordon config show` | Show server configuration | [config](./config.md) |
31+| `gordon deploy` | Manually deploy or redeploy a route | [serve](./serve.md#gordon-deploy) |
32+| `gordon images` | List and prune images | [images](./images.md) |
33+| `gordon logs` | Display Gordon process or container logs | [serve](./serve.md#gordon-logs) |
34+| `gordon networks list` | List Gordon-managed Docker networks | [networks](./networks.md) |
35+| `gordon preview` | Create or manage preview environments | [preview](../config/preview.md) |
3236 | `gordon push` | Tag, push, and optionally deploy an image | [push](./push.md) |
3337 | `gordon attachments push` | Build/push attachment images to registry | [attachments](./attachments.md) |
34-| `gordon rollback` | Roll back to a previous image tag | [rollback](./rollback.md) |
3538 | `gordon reload` | Reload configuration and sync containers | [serve](./serve.md#gordon-reload) |
36-| `gordon logs` | Display Gordon process or container logs | [serve](./serve.md#gordon-logs) |
39+| `gordon restart` | Restart a running container | [restart](./restart.md) |
40+| `gordon rollback` | Roll back to a previous image version | [rollback](./rollback.md) |
41+| `gordon routes` | Manage routes | [routes](./routes.md) |
42+| `gordon secrets` | Manage secrets | [secrets](./secrets.md) |
3743 | `gordon status` | Show Gordon server status | [status](./status.md) |
38-| `gordon backups` | Manage database backups | [backup](./backup.md) |
39-| `gordon images` | List and prune images | [images](./images.md) |
40-| `gordon config show` | Show server configuration | [config](./config.md) |
41-| `gordon networks list` | List Gordon-managed Docker networks | [networks](./networks.md) |
42-| `gordon autoroute` | Manage auto-route domain allowlist | [autoroute](./autoroute.md) |
44+| `gordon volumes` | Manage volumes | - |
4345
4446 ## Client Commands
4547
@@ -102,10 +104,13 @@ gordon images prune --runtime-only
102104 gordon images prune --keep 3
103105
104106 # Authentication
107+gordon auth login --remote https://gordon.example.com --token $TOKEN
108+gordon auth status
109+gordon auth show-token
110+gordon auth logout
105111 gordon auth token generate --subject ci-bot --expiry 0
106112 gordon auth token list
107113 gordon auth token revoke <token-id>
108-gordon auth password hash
109114 gordon auth internal
110115
111116 # Routes
@@ -129,6 +134,16 @@ gordon remotes add prod https://gordon.mydomain.com --token $TOKEN
129134 gordon remotes list
130135 gordon remotes use prod
131136
137+# Preview environments
138+gordon preview create app.example.com --branch feature-x
139+gordon preview list
140+gordon preview extend app.example.com --branch feature-x
141+gordon preview delete app.example.com --branch feature-x
142+
143+# Volumes
144+gordon volumes list
145+gordon volumes prune
146+
132147 # Auto-route allowlist
133148 gordon autoroute allow list
134149 gordon autoroute allow add example.com
@@ -23,23 +23,25 @@ Management commands run locally through in-process services by default. Add `--r
23 23
24 | Command | Description | Documentation |24 | Command | Description | Documentation |
25 |---------|-------------|---------------|25 |---------|-------------|---------------|
26-| `gordon routes` | Manage routes | [routes](./routes.md) |
27 | `gordon attachments` | Manage container attachments | [attachments](./attachments.md) |26 | `gordon attachments` | Manage container attachments | [attachments](./attachments.md) |
28-| `gordon secrets` | Manage secrets | [secrets](./secrets.md) |27+| `gordon autoroute` | Manage auto-route domain allowlist | [autoroute](./autoroute.md) |
29-| `gordon deploy` | Manually deploy or redeploy a route | [serve](./serve.md#gordon-deploy) |28+| `gordon backups` | Manage database backups | [backup](./backup.md) |
30-| `gordon restart` | Restart a running container | [restart](./restart.md) |
31 | `gordon bootstrap` | Configure a route, attachments, and secrets for an app | [bootstrap](./bootstrap.md) |29 | `gordon bootstrap` | Configure a route, attachments, and secrets for an app | [bootstrap](./bootstrap.md) |
30+| `gordon config show` | Show server configuration | [config](./config.md) |
31+| `gordon deploy` | Manually deploy or redeploy a route | [serve](./serve.md#gordon-deploy) |
32+| `gordon images` | List and prune images | [images](./images.md) |
33+| `gordon logs` | Display Gordon process or container logs | [serve](./serve.md#gordon-logs) |
34+| `gordon networks list` | List Gordon-managed Docker networks | [networks](./networks.md) |
35+| `gordon preview` | Create or manage preview environments | [preview](../config/preview.md) |
32 | `gordon push` | Tag, push, and optionally deploy an image | [push](./push.md) |36 | `gordon push` | Tag, push, and optionally deploy an image | [push](./push.md) |
33 | `gordon attachments push` | Build/push attachment images to registry | [attachments](./attachments.md) |37 | `gordon attachments push` | Build/push attachment images to registry | [attachments](./attachments.md) |
34-| `gordon rollback` | Roll back to a previous image tag | [rollback](./rollback.md) |
35 | `gordon reload` | Reload configuration and sync containers | [serve](./serve.md#gordon-reload) |38 | `gordon reload` | Reload configuration and sync containers | [serve](./serve.md#gordon-reload) |
36-| `gordon logs` | Display Gordon process or container logs | [serve](./serve.md#gordon-logs) |39+| `gordon restart` | Restart a running container | [restart](./restart.md) |
40+| `gordon rollback` | Roll back to a previous image version | [rollback](./rollback.md) |
41+| `gordon routes` | Manage routes | [routes](./routes.md) |
42+| `gordon secrets` | Manage secrets | [secrets](./secrets.md) |
37 | `gordon status` | Show Gordon server status | [status](./status.md) |43 | `gordon status` | Show Gordon server status | [status](./status.md) |
38-| `gordon backups` | Manage database backups | [backup](./backup.md) |44+| `gordon volumes` | Manage volumes | - |
39-| `gordon images` | List and prune images | [images](./images.md) |
40-| `gordon config show` | Show server configuration | [config](./config.md) |
41-| `gordon networks list` | List Gordon-managed Docker networks | [networks](./networks.md) |
42-| `gordon autoroute` | Manage auto-route domain allowlist | [autoroute](./autoroute.md) |
43 45
44 ## Client Commands46 ## Client Commands
45 47
@@ -102,10 +104,13 @@ gordon images prune --runtime-only
102 gordon images prune --keep 3104 gordon images prune --keep 3
103 105
104 # Authentication106 # Authentication
107+gordon auth login --remote https://gordon.example.com --token $TOKEN
108+gordon auth status
109+gordon auth show-token
110+gordon auth logout
105 gordon auth token generate --subject ci-bot --expiry 0111 gordon auth token generate --subject ci-bot --expiry 0
106 gordon auth token list112 gordon auth token list
107 gordon auth token revoke <token-id>113 gordon auth token revoke <token-id>
108-gordon auth password hash
109 gordon auth internal114 gordon auth internal
110 115
111 # Routes116 # Routes
@@ -129,6 +134,16 @@ gordon remotes add prod https://gordon.mydomain.com --token $TOKEN
129 gordon remotes list134 gordon remotes list
130 gordon remotes use prod135 gordon remotes use prod
131 136
137+# Preview environments
138+gordon preview create app.example.com --branch feature-x
139+gordon preview list
140+gordon preview extend app.example.com --branch feature-x
141+gordon preview delete app.example.com --branch feature-x
142+
143+# Volumes
144+gordon volumes list
145+gordon volumes prune
146+
132 # Auto-route allowlist147 # Auto-route allowlist
133 gordon autoroute allow list148 gordon autoroute allow list
134 gordon autoroute allow add example.com149 gordon autoroute allow add example.com

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 7

Tags 106

↑↓ moveenter openesc close