detached 06c2247

docs: add missing CLI docs and fix broken wiki links

Add docs/cli/volumes.md and docs/cli/preview.md.
Remove dead links to unwritten guides (nextjs-deploy,
multi-service-app, cloudflare-setup).
commit
06c2247c4a099a5dc3eed2a32814b09041b1c6eb
author
brice · · 2026-03-28 08:07 UTC
parent
83e8199
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
5 files · +100 -7
Split
UnifiedSplit
A docs/cli/preview.md +61 -0
@@ -0,0 +1,61 @@
1+# gordon preview
2+
3+Create and manage ephemeral preview environments. Each preview gets its own subdomain, container, and optionally cloned volumes from the base route.
4+
5+## Commands
6+
7+### `gordon preview create`
8+
9+Build, push, and deploy a preview environment.
10+
11+```bash
12+gordon preview create myapp
13+gordon preview create myapp --ttl 72h
14+gordon preview create myapp --no-build --no-data
15+```
16+
17+| Flag | Description |
18+|------|-------------|
19+| `--ttl` | Override TTL duration (e.g., `72h`) |
20+| `--no-build` | Skip image build (use existing image) |
21+| `--no-data` | Skip volume cloning from base route |
22+| `--platform` | Target platform for build (default `linux/amd64`) |
23+
24+### `gordon preview list`
25+
26+List active preview environments with status and remaining TTL.
27+
28+```bash
29+gordon preview list
30+gordon preview list --json
31+```
32+
33+| Flag | Description |
34+|------|-------------|
35+| `--json` | Output as JSON |
36+
37+### `gordon preview delete`
38+
39+Tear down a preview environment and clean up its resources.
40+
41+```bash
42+gordon preview delete myapp-feature-x
43+```
44+
45+### `gordon preview extend`
46+
47+Extend the TTL of an active preview.
48+
49+```bash
50+gordon preview extend myapp-feature-x
51+gordon preview extend myapp-feature-x --ttl 48h
52+```
53+
54+| Flag | Description |
55+|------|-------------|
56+| `--ttl` | Additional TTL to add (default `24h`) |
57+
58+## Related
59+
60+- [Preview Configuration](../config/preview.md)
61+- [Deploy](./serve.md#gordon-deploy)
@@ -0,0 +1,61 @@
1+# gordon preview
2+
3+Create and manage ephemeral preview environments. Each preview gets its own subdomain, container, and optionally cloned volumes from the base route.
4+
5+## Commands
6+
7+### `gordon preview create`
8+
9+Build, push, and deploy a preview environment.
10+
11+```bash
12+gordon preview create myapp
13+gordon preview create myapp --ttl 72h
14+gordon preview create myapp --no-build --no-data
15+```
16+
17+| Flag | Description |
18+|------|-------------|
19+| `--ttl` | Override TTL duration (e.g., `72h`) |
20+| `--no-build` | Skip image build (use existing image) |
21+| `--no-data` | Skip volume cloning from base route |
22+| `--platform` | Target platform for build (default `linux/amd64`) |
23+
24+### `gordon preview list`
25+
26+List active preview environments with status and remaining TTL.
27+
28+```bash
29+gordon preview list
30+gordon preview list --json
31+```
32+
33+| Flag | Description |
34+|------|-------------|
35+| `--json` | Output as JSON |
36+
37+### `gordon preview delete`
38+
39+Tear down a preview environment and clean up its resources.
40+
41+```bash
42+gordon preview delete myapp-feature-x
43+```
44+
45+### `gordon preview extend`
46+
47+Extend the TTL of an active preview.
48+
49+```bash
50+gordon preview extend myapp-feature-x
51+gordon preview extend myapp-feature-x --ttl 48h
52+```
53+
54+| Flag | Description |
55+|------|-------------|
56+| `--ttl` | Additional TTL to add (default `24h`) |
57+
58+## Related
59+
60+- [Preview Configuration](../config/preview.md)
61+- [Deploy](./serve.md#gordon-deploy)
A docs/cli/volumes.md +39 -0
@@ -0,0 +1,39 @@
1+# gordon volumes
2+
3+List and clean up Docker volumes managed by Gordon.
4+
5+## Commands
6+
7+### `gordon volumes list`
8+
9+List all Gordon-managed volumes.
10+
11+```bash
12+gordon volumes list
13+gordon volumes list --json
14+```
15+
16+| Flag | Description |
17+|------|-------------|
18+| `--json` | Output as JSON |
19+
20+### `gordon volumes prune`
21+
22+Remove orphaned volumes no longer associated with a running container.
23+
24+```bash
25+gordon volumes prune
26+gordon volumes prune --dry-run
27+gordon volumes prune --no-confirm
28+```
29+
30+| Flag | Description |
31+|------|-------------|
32+| `--dry-run` | Show what would be removed without deleting |
33+| `--no-confirm` | Skip confirmation prompt |
34+| `--json` | Output as JSON |
35+
36+## Related
37+
38+- [Volumes Configuration](../config/volumes.md)
39+- [Images](./images.md)
@@ -0,0 +1,39 @@
1+# gordon volumes
2+
3+List and clean up Docker volumes managed by Gordon.
4+
5+## Commands
6+
7+### `gordon volumes list`
8+
9+List all Gordon-managed volumes.
10+
11+```bash
12+gordon volumes list
13+gordon volumes list --json
14+```
15+
16+| Flag | Description |
17+|------|-------------|
18+| `--json` | Output as JSON |
19+
20+### `gordon volumes prune`
21+
22+Remove orphaned volumes no longer associated with a running container.
23+
24+```bash
25+gordon volumes prune
26+gordon volumes prune --dry-run
27+gordon volumes prune --no-confirm
28+```
29+
30+| Flag | Description |
31+|------|-------------|
32+| `--dry-run` | Show what would be removed without deleting |
33+| `--no-confirm` | Skip confirmation prompt |
34+| `--json` | Output as JSON |
35+
36+## Related
37+
38+- [Volumes Configuration](../config/volumes.md)
39+- [Images](./images.md)
M wiki/guides/podman-rootless.md +0 -1
@@ -229,6 +229,5 @@ loginctl show-user $USER | grep Linger
229229
230230 ## Next Steps
231231
232-- [Configure Cloudflare](./cloudflare-setup.md)
233232 - [Set up secrets](./secrets-pass.md)
234233 - [Deploy your first app](/wiki/tutorials/first-deploy.md)
@@ -229,6 +229,5 @@ loginctl show-user $USER | grep Linger
229 229
230 ## Next Steps230 ## Next Steps
231 231
232-- [Configure Cloudflare](./cloudflare-setup.md)
233 - [Set up secrets](./secrets-pass.md)232 - [Set up secrets](./secrets-pass.md)
234 - [Deploy your first app](/wiki/tutorials/first-deploy.md)233 - [Deploy your first app](/wiki/tutorials/first-deploy.md)
M wiki/tutorials/index.md +0 -5
@@ -8,13 +8,8 @@ Step-by-step guides for common Gordon tasks.
88
99 ## Framework Tutorials
1010
11-- [Deploy a Next.js App](./nextjs-deploy.md) - Full-stack Next.js deployment
1211 - [Add PostgreSQL to Your App](./postgres-service.md) - Database attachments
1312
14-## Advanced
15-
16-- [Deploy Multi-Service Applications](./multi-service-app.md) - Microservices with shared services
17-
1813 ## Prerequisites
1914
2015 Before starting tutorials, you should have:
@@ -8,13 +8,8 @@ Step-by-step guides for common Gordon tasks.
8 8
9 ## Framework Tutorials9 ## Framework Tutorials
10 10
11-- [Deploy a Next.js App](./nextjs-deploy.md) - Full-stack Next.js deployment
12 - [Add PostgreSQL to Your App](./postgres-service.md) - Database attachments11 - [Add PostgreSQL to Your App](./postgres-service.md) - Database attachments
13 12
14-## Advanced
15-
16-- [Deploy Multi-Service Applications](./multi-service-app.md) - Microservices with shared services
17-
18 ## Prerequisites13 ## Prerequisites
19 14
20 Before starting tutorials, you should have:15 Before starting tutorials, you should have:
M wiki/tutorials/postgres-service.md +0 -1
@@ -200,6 +200,5 @@ cat backup.sql | docker exec -i gordon-app-mydomain-com-my-postgres \
200200
201201 ## Next Steps
202202
203-- [Add Redis cache](./multi-service-app.md)
204203 - [Configure secrets](/docs/config/secrets.md)
205204 - [Network isolation](/docs/config/network-isolation.md)
@@ -200,6 +200,5 @@ cat backup.sql | docker exec -i gordon-app-mydomain-com-my-postgres \
200 200
201 ## Next Steps201 ## Next Steps
202 202
203-- [Add Redis cache](./multi-service-app.md)
204 - [Configure secrets](/docs/config/secrets.md)203 - [Configure secrets](/docs/config/secrets.md)
205 - [Network isolation](/docs/config/network-isolation.md)204 - [Network isolation](/docs/config/network-isolation.md)

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