detached 40943be

docs(cli): update --remote flag to -r, document name-based resolution

commit
40943be2d7d3e59388f066d6c73a4b3c2eaba996
author
brice · · 2026-04-04 11:37 UTC
parent
c58e6af
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
13 files · +34 -26
M docs/cli/attachments.md +4 -4
@@ -85,7 +85,7 @@ gordon attachments list --json
8585 | Option | Description |
8686 |--------|-------------|
8787 | `--json` | Output attachments as JSON |
88-| `--remote` | Remote Gordon URL |
88+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
8989 | `--token` | Authentication token for remote |
9090
9191 ---
@@ -111,7 +111,7 @@ gordon attachments add backend redis:7-alpine
111111
112112 | Option | Description |
113113 |--------|-------------|
114-| `--remote` | Remote Gordon URL |
114+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
115115 | `--token` | Authentication token for remote |
116116
117117 ### Examples
@@ -152,7 +152,7 @@ gordon attachments push <image> [options]
152152 | `--platform` | Target platform for buildx (default: `linux/amd64`) |
153153 | `--build-arg` | Additional build args (repeatable, `KEY=VALUE`) |
154154 | `--tag` | Override version tag |
155-| `--remote` | Remote Gordon URL |
155+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
156156 | `--token` | Authentication token for remote |
157157
158158 ### Description
@@ -199,7 +199,7 @@ gordon attachments remove app.example.com postgres:18
199199
200200 | Option | Description |
201201 |--------|-------------|
202-| `--remote` | Remote Gordon URL |
202+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
203203 | `--token` | Authentication token for remote |
204204
205205 ### Examples
@@ -85,7 +85,7 @@ gordon attachments list --json
85 | Option | Description |85 | Option | Description |
86 |--------|-------------|86 |--------|-------------|
87 | `--json` | Output attachments as JSON |87 | `--json` | Output attachments as JSON |
88-| `--remote` | Remote Gordon URL |88+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
89 | `--token` | Authentication token for remote |89 | `--token` | Authentication token for remote |
90 90
91 ---91 ---
@@ -111,7 +111,7 @@ gordon attachments add backend redis:7-alpine
111 111
112 | Option | Description |112 | Option | Description |
113 |--------|-------------|113 |--------|-------------|
114-| `--remote` | Remote Gordon URL |114+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
115 | `--token` | Authentication token for remote |115 | `--token` | Authentication token for remote |
116 116
117 ### Examples117 ### Examples
@@ -152,7 +152,7 @@ gordon attachments push <image> [options]
152 | `--platform` | Target platform for buildx (default: `linux/amd64`) |152 | `--platform` | Target platform for buildx (default: `linux/amd64`) |
153 | `--build-arg` | Additional build args (repeatable, `KEY=VALUE`) |153 | `--build-arg` | Additional build args (repeatable, `KEY=VALUE`) |
154 | `--tag` | Override version tag |154 | `--tag` | Override version tag |
155-| `--remote` | Remote Gordon URL |155+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
156 | `--token` | Authentication token for remote |156 | `--token` | Authentication token for remote |
157 157
158 ### Description158 ### Description
@@ -199,7 +199,7 @@ gordon attachments remove app.example.com postgres:18
199 199
200 | Option | Description |200 | Option | Description |
201 |--------|-------------|201 |--------|-------------|
202-| `--remote` | Remote Gordon URL |202+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
203 | `--token` | Authentication token for remote |203 | `--token` | Authentication token for remote |
204 204
205 ### Examples205 ### Examples
M docs/cli/auth.md +4 -2
@@ -32,7 +32,8 @@ gordon auth login --token <token> [options]
3232 | Option | Description |
3333 |--------|-------------|
3434 | `-t, --token` | **Required.** Authentication token to store |
35-| `-r, --remote` | Remote to authenticate with (defaults to active remote) |
35+
36+Use the global `--remote, -r` flag to target a specific remote. See [CLI Overview](./index.md).
3637
3738 ### Description
3839
@@ -94,9 +95,10 @@ gordon auth logout [--remote <name>] [--revoke]
9495
9596 | Option | Description |
9697 |--------|-------------|
97-| `-r, --remote` | Remote to log out from (defaults to active remote) |
9898 | `--revoke` | Also revoke the token server-side (not yet implemented) |
9999
100+Use the global `--remote, -r` flag to target a specific remote. See [CLI Overview](./index.md).
101+
100102 Deletes the token from pass and clears token fields in `remotes.toml`.
101103
102104 ---
@@ -32,7 +32,8 @@ gordon auth login --token <token> [options]
32 | Option | Description |32 | Option | Description |
33 |--------|-------------|33 |--------|-------------|
34 | `-t, --token` | **Required.** Authentication token to store |34 | `-t, --token` | **Required.** Authentication token to store |
35-| `-r, --remote` | Remote to authenticate with (defaults to active remote) |35+
36+Use the global `--remote, -r` flag to target a specific remote. See [CLI Overview](./index.md).
36 37
37 ### Description38 ### Description
38 39
@@ -94,9 +95,10 @@ gordon auth logout [--remote <name>] [--revoke]
94 95
95 | Option | Description |96 | Option | Description |
96 |--------|-------------|97 |--------|-------------|
97-| `-r, --remote` | Remote to log out from (defaults to active remote) |
98 | `--revoke` | Also revoke the token server-side (not yet implemented) |98 | `--revoke` | Also revoke the token server-side (not yet implemented) |
99 99
100+Use the global `--remote, -r` flag to target a specific remote. See [CLI Overview](./index.md).
101+
100 Deletes the token from pass and clears token fields in `remotes.toml`.102 Deletes the token from pass and clears token fields in `remotes.toml`.
101 103
102 ---104 ---
M docs/cli/autoroute.md +3 -3
@@ -59,7 +59,7 @@ gordon autoroute allow add example.com --remote https://gordon.mydomain.com --to
5959
6060 | Option | Description |
6161 |--------|-------------|
62-| `--remote` | Remote Gordon URL |
62+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
6363 | `--token` | Authentication token for remote |
6464
6565 ### Description
@@ -103,7 +103,7 @@ gordon autoroute allow list --remote https://gordon.mydomain.com --token $TOKEN
103103 | Option | Description |
104104 |--------|-------------|
105105 | `--json` | Output allowed domains as JSON |
106-| `--remote` | Remote Gordon URL |
106+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
107107 | `--token` | Authentication token for remote |
108108
109109 ### Description
@@ -171,7 +171,7 @@ gordon autoroute allow remove example.com --remote https://gordon.mydomain.com -
171171
172172 | Option | Description |
173173 |--------|-------------|
174-| `--remote` | Remote Gordon URL |
174+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
175175 | `--token` | Authentication token for remote |
176176
177177 ### Description
@@ -59,7 +59,7 @@ gordon autoroute allow add example.com --remote https://gordon.mydomain.com --to
59 59
60 | Option | Description |60 | Option | Description |
61 |--------|-------------|61 |--------|-------------|
62-| `--remote` | Remote Gordon URL |62+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
63 | `--token` | Authentication token for remote |63 | `--token` | Authentication token for remote |
64 64
65 ### Description65 ### Description
@@ -103,7 +103,7 @@ gordon autoroute allow list --remote https://gordon.mydomain.com --token $TOKEN
103 | Option | Description |103 | Option | Description |
104 |--------|-------------|104 |--------|-------------|
105 | `--json` | Output allowed domains as JSON |105 | `--json` | Output allowed domains as JSON |
106-| `--remote` | Remote Gordon URL |106+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
107 | `--token` | Authentication token for remote |107 | `--token` | Authentication token for remote |
108 108
109 ### Description109 ### Description
@@ -171,7 +171,7 @@ gordon autoroute allow remove example.com --remote https://gordon.mydomain.com -
171 171
172 | Option | Description |172 | Option | Description |
173 |--------|-------------|173 |--------|-------------|
174-| `--remote` | Remote Gordon URL |174+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
175 | `--token` | Authentication token for remote |175 | `--token` | Authentication token for remote |
176 176
177 ### Description177 ### Description
M docs/cli/bootstrap.md +1 -1
@@ -23,7 +23,7 @@ gordon bootstrap <domain> <image> [options]
2323 |--------|-------------|
2424 | `--attachment` | Add an attachment to the route (repeatable) |
2525 | `--env` | Set an environment variable for the route (repeatable, `KEY=VALUE`) |
26-| `--remote` | Remote Gordon URL |
26+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
2727 | `--token` | Authentication token for remote |
2828
2929 ### Description
@@ -23,7 +23,7 @@ gordon bootstrap <domain> <image> [options]
23 |--------|-------------|23 |--------|-------------|
24 | `--attachment` | Add an attachment to the route (repeatable) |24 | `--attachment` | Add an attachment to the route (repeatable) |
25 | `--env` | Set an environment variable for the route (repeatable, `KEY=VALUE`) |25 | `--env` | Set an environment variable for the route (repeatable, `KEY=VALUE`) |
26-| `--remote` | Remote Gordon URL |26+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
27 | `--token` | Authentication token for remote |27 | `--token` | Authentication token for remote |
28 28
29 ### Description29 ### Description
M docs/cli/index.md +1 -1
@@ -157,7 +157,7 @@ gordon autoroute allow remove example.com
157157 | Option | Description |
158158 |--------|-------------|
159159 | `-c, --config` | Path to configuration file |
160-| `--remote` | Remote Gordon URL (e.g., `https://gordon.mydomain.com`) |
160+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
161161 | `--token` | Authentication token for remote |
162162 | `--insecure` | Skip TLS certificate verification for remote HTTPS endpoints |
163163
@@ -157,7 +157,7 @@ gordon autoroute allow remove example.com
157 | Option | Description |157 | Option | Description |
158 |--------|-------------|158 |--------|-------------|
159 | `-c, --config` | Path to configuration file |159 | `-c, --config` | Path to configuration file |
160-| `--remote` | Remote Gordon URL (e.g., `https://gordon.mydomain.com`) |160+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
161 | `--token` | Authentication token for remote |161 | `--token` | Authentication token for remote |
162 | `--insecure` | Skip TLS certificate verification for remote HTTPS endpoints |162 | `--insecure` | Skip TLS certificate verification for remote HTTPS endpoints |
163 163
M docs/cli/push.md +1 -1
@@ -28,7 +28,7 @@ gordon push [image] [options]
2828 | `--no-confirm` | Skip deploy confirmation prompt |
2929 | `--no-deploy` | Push only; skip deployment prompt |
3030 | `--domain` | Explicit domain override (legacy mode) |
31-| `--remote` | Remote Gordon URL |
31+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
3232 | `--token` | Authentication token for remote |
3333
3434 ### Description
@@ -28,7 +28,7 @@ gordon push [image] [options]
28 | `--no-confirm` | Skip deploy confirmation prompt |28 | `--no-confirm` | Skip deploy confirmation prompt |
29 | `--no-deploy` | Push only; skip deployment prompt |29 | `--no-deploy` | Push only; skip deployment prompt |
30 | `--domain` | Explicit domain override (legacy mode) |30 | `--domain` | Explicit domain override (legacy mode) |
31-| `--remote` | Remote Gordon URL |31+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
32 | `--token` | Authentication token for remote |32 | `--token` | Authentication token for remote |
33 33
34 ### Description34 ### Description
M docs/cli/remotes.md +6 -0
@@ -337,6 +337,12 @@ If you have your own certificate for the domain (e.g. from a corporate CA), you
337337
338338 `insecure_tls` only affects CLI -> Gordon admin HTTPS verification. It does not change runtime routing: Gordon reverse proxy and container routes can still serve wildcard app domains like `*.example.com`.
339339
340+## Migration from [client] Config
341+
342+The `[client]` section in `gordon.toml` is deprecated. On first run, Gordon
343+auto-migrates it to a `default` remote entry in `remotes.toml` and sets it
344+as active. No manual action needed.
345+
340346 ## Related
341347
342348 - [CLI Overview](./index.md)
@@ -337,6 +337,12 @@ If you have your own certificate for the domain (e.g. from a corporate CA), you
337 337
338 `insecure_tls` only affects CLI -> Gordon admin HTTPS verification. It does not change runtime routing: Gordon reverse proxy and container routes can still serve wildcard app domains like `*.example.com`.338 `insecure_tls` only affects CLI -> Gordon admin HTTPS verification. It does not change runtime routing: Gordon reverse proxy and container routes can still serve wildcard app domains like `*.example.com`.
339 339
340+## Migration from [client] Config
341+
342+The `[client]` section in `gordon.toml` is deprecated. On first run, Gordon
343+auto-migrates it to a `default` remote entry in `remotes.toml` and sets it
344+as active. No manual action needed.
345+
340 ## Related346 ## Related
341 347
342 - [CLI Overview](./index.md)348 - [CLI Overview](./index.md)
M docs/cli/restart.md +1 -1
@@ -21,7 +21,7 @@ gordon restart <domain> [options]
2121 | Option | Description |
2222 |--------|-------------|
2323 | `--with-attachments` | Also restart attached services (databases, caches) |
24-| `--remote` | Remote Gordon URL |
24+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
2525 | `--token` | Authentication token for remote |
2626
2727 ### Description
@@ -21,7 +21,7 @@ gordon restart <domain> [options]
21 | Option | Description |21 | Option | Description |
22 |--------|-------------|22 |--------|-------------|
23 | `--with-attachments` | Also restart attached services (databases, caches) |23 | `--with-attachments` | Also restart attached services (databases, caches) |
24-| `--remote` | Remote Gordon URL |24+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
25 | `--token` | Authentication token for remote |25 | `--token` | Authentication token for remote |
26 26
27 ### Description27 ### Description
M docs/cli/rollback.md +1 -1
@@ -22,7 +22,7 @@ gordon rollback list <domain>
2222 | Option | Description |
2323 |--------|-------------|
2424 | `--tag` | Target tag (skips interactive selection) |
25-| `--remote` | Remote Gordon URL |
25+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
2626 | `--token` | Authentication token for remote |
2727
2828 ### Description
@@ -22,7 +22,7 @@ gordon rollback list <domain>
22 | Option | Description |22 | Option | Description |
23 |--------|-------------|23 |--------|-------------|
24 | `--tag` | Target tag (skips interactive selection) |24 | `--tag` | Target tag (skips interactive selection) |
25-| `--remote` | Remote Gordon URL |25+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
26 | `--token` | Authentication token for remote |26 | `--token` | Authentication token for remote |
27 27
28 ### Description28 ### Description
M docs/cli/routes.md +5 -5
@@ -65,7 +65,7 @@ gordon routes list --json
6565 | Option | Description |
6666 |--------|-------------|
6767 | `--json` | Output routes as JSON |
68-| `--remote` | Remote Gordon URL |
68+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
6969 | `--token` | Authentication token for remote |
7070
7171 ---
@@ -93,7 +93,7 @@ The image does not need to be pushed to the Gordon registry before you add the r
9393
9494 | Option | Description |
9595 |--------|-------------|
96-| `--remote` | Remote Gordon URL |
96+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
9797 | `--token` | Authentication token for remote |
9898
9999 ### Examples
@@ -138,7 +138,7 @@ gordon routes show myapp.example.com --json
138138 | Option | Description |
139139 |--------|-------------|
140140 | `--json` | Output route details as JSON |
141-| `--remote` | Remote Gordon URL |
141+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
142142 | `--token` | Authentication token for remote |
143143
144144 ### Description
@@ -191,7 +191,7 @@ gordon routes remove myapp.example.com
191191
192192 | Option | Description |
193193 |--------|-------------|
194-| `--remote` | Remote Gordon URL |
194+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
195195 | `--token` | Authentication token for remote |
196196
197197 ### Examples
@@ -225,7 +225,7 @@ gordon routes deploy myapp.example.com
225225
226226 | Option | Description |
227227 |--------|-------------|
228-| `--remote` | Remote Gordon URL |
228+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
229229 | `--token` | Authentication token for remote |
230230
231231 ### Description
@@ -65,7 +65,7 @@ gordon routes list --json
65 | Option | Description |65 | Option | Description |
66 |--------|-------------|66 |--------|-------------|
67 | `--json` | Output routes as JSON |67 | `--json` | Output routes as JSON |
68-| `--remote` | Remote Gordon URL |68+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
69 | `--token` | Authentication token for remote |69 | `--token` | Authentication token for remote |
70 70
71 ---71 ---
@@ -93,7 +93,7 @@ The image does not need to be pushed to the Gordon registry before you add the r
93 93
94 | Option | Description |94 | Option | Description |
95 |--------|-------------|95 |--------|-------------|
96-| `--remote` | Remote Gordon URL |96+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
97 | `--token` | Authentication token for remote |97 | `--token` | Authentication token for remote |
98 98
99 ### Examples99 ### Examples
@@ -138,7 +138,7 @@ gordon routes show myapp.example.com --json
138 | Option | Description |138 | Option | Description |
139 |--------|-------------|139 |--------|-------------|
140 | `--json` | Output route details as JSON |140 | `--json` | Output route details as JSON |
141-| `--remote` | Remote Gordon URL |141+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
142 | `--token` | Authentication token for remote |142 | `--token` | Authentication token for remote |
143 143
144 ### Description144 ### Description
@@ -191,7 +191,7 @@ gordon routes remove myapp.example.com
191 191
192 | Option | Description |192 | Option | Description |
193 |--------|-------------|193 |--------|-------------|
194-| `--remote` | Remote Gordon URL |194+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
195 | `--token` | Authentication token for remote |195 | `--token` | Authentication token for remote |
196 196
197 ### Examples197 ### Examples
@@ -225,7 +225,7 @@ gordon routes deploy myapp.example.com
225 225
226 | Option | Description |226 | Option | Description |
227 |--------|-------------|227 |--------|-------------|
228-| `--remote` | Remote Gordon URL |228+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
229 | `--token` | Authentication token for remote |229 | `--token` | Authentication token for remote |
230 230
231 ### Description231 ### Description
M docs/cli/secrets.md +3 -3
@@ -40,7 +40,7 @@ gordon secrets list <domain>
4040 | Option | Description |
4141 |--------|-------------|
4242 | `--json` | Output secrets as JSON |
43-| `--remote` | Remote Gordon URL |
43+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
4444 | `--token` | Authentication token for remote |
4545
4646 ### Examples
@@ -117,7 +117,7 @@ gordon secrets set myapp.local DATABASE_URL "postgres://..."
117117 | Option | Description |
118118 |--------|-------------|
119119 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |
120-| `--remote` | Remote Gordon URL |
120+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
121121 | `--token` | Authentication token for remote |
122122
123123 ### Examples
@@ -160,7 +160,7 @@ gordon secrets remove <domain> <key>
160160 | Option | Description |
161161 |--------|-------------|
162162 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |
163-| `--remote` | Remote Gordon URL |
163+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
164164 | `--token` | Authentication token for remote |
165165
166166 ### Examples
@@ -40,7 +40,7 @@ gordon secrets list <domain>
40 | Option | Description |40 | Option | Description |
41 |--------|-------------|41 |--------|-------------|
42 | `--json` | Output secrets as JSON |42 | `--json` | Output secrets as JSON |
43-| `--remote` | Remote Gordon URL |43+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
44 | `--token` | Authentication token for remote |44 | `--token` | Authentication token for remote |
45 45
46 ### Examples46 ### Examples
@@ -117,7 +117,7 @@ gordon secrets set myapp.local DATABASE_URL "postgres://..."
117 | Option | Description |117 | Option | Description |
118 |--------|-------------|118 |--------|-------------|
119 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |119 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |
120-| `--remote` | Remote Gordon URL |120+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
121 | `--token` | Authentication token for remote |121 | `--token` | Authentication token for remote |
122 122
123 ### Examples123 ### Examples
@@ -160,7 +160,7 @@ gordon secrets remove <domain> <key>
160 | Option | Description |160 | Option | Description |
161 |--------|-------------|161 |--------|-------------|
162 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |162 | `--attachment` / `-a` | Target an attachment service (e.g., postgres, redis) |
163-| `--remote` | Remote Gordon URL |163+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
164 | `--token` | Authentication token for remote |164 | `--token` | Authentication token for remote |
165 165
166 ### Examples166 ### Examples
M docs/cli/serve.md +2 -2
@@ -169,7 +169,7 @@ gordon deploy <domain> [options]
169169
170170 | Option | Description |
171171 |--------|-------------|
172-| `--remote` | Remote Gordon URL |
172+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
173173 | `--token` | Authentication token for remote |
174174
175175 Remote targeting uses client config or an active remote by default.
@@ -229,7 +229,7 @@ gordon logs [domain] [options]
229229 | `--config` | `-c` | Auto | Path to config file |
230230 | `--follow` | `-f` | false | Follow log output (like `tail -f`) |
231231 | `--lines` | `-n` | 50 | Number of lines to show |
232-| `--remote` | | | Remote Gordon URL |
232+| `--remote, -r` | | | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
233233 | `--token` | | | Authentication token for remote |
234234
235235 Remote targeting uses client config or an active remote by default.
@@ -169,7 +169,7 @@ gordon deploy <domain> [options]
169 169
170 | Option | Description |170 | Option | Description |
171 |--------|-------------|171 |--------|-------------|
172-| `--remote` | Remote Gordon URL |172+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
173 | `--token` | Authentication token for remote |173 | `--token` | Authentication token for remote |
174 174
175 Remote targeting uses client config or an active remote by default.175 Remote targeting uses client config or an active remote by default.
@@ -229,7 +229,7 @@ gordon logs [domain] [options]
229 | `--config` | `-c` | Auto | Path to config file |229 | `--config` | `-c` | Auto | Path to config file |
230 | `--follow` | `-f` | false | Follow log output (like `tail -f`) |230 | `--follow` | `-f` | false | Follow log output (like `tail -f`) |
231 | `--lines` | `-n` | 50 | Number of lines to show |231 | `--lines` | `-n` | 50 | Number of lines to show |
232-| `--remote` | | | Remote Gordon URL |232+| `--remote, -r` | | | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
233 | `--token` | | | Authentication token for remote |233 | `--token` | | | Authentication token for remote |
234 234
235 Remote targeting uses client config or an active remote by default.235 Remote targeting uses client config or an active remote by default.
M docs/cli/status.md +2 -2
@@ -62,14 +62,14 @@ The status command uses global flags for remote access:
6262
6363 | Flag | Description |
6464 |------|-------------|
65-| `--remote` | Remote Gordon URL |
65+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
6666 | `--token` | Authentication token |
6767
6868 ## Environment Variables
6969
7070 | Variable | Description |
7171 |----------|-------------|
72-| `GORDON_REMOTE` | Remote Gordon URL |
72+| `GORDON_REMOTE` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
7373 | `GORDON_TOKEN` | Authentication token |
7474
7575 ## Examples
@@ -62,14 +62,14 @@ The status command uses global flags for remote access:
62 62
63 | Flag | Description |63 | Flag | Description |
64 |------|-------------|64 |------|-------------|
65-| `--remote` | Remote Gordon URL |65+| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
66 | `--token` | Authentication token |66 | `--token` | Authentication token |
67 67
68 ## Environment Variables68 ## Environment Variables
69 69
70 | Variable | Description |70 | Variable | Description |
71 |----------|-------------|71 |----------|-------------|
72-| `GORDON_REMOTE` | Remote Gordon URL |72+| `GORDON_REMOTE` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
73 | `GORDON_TOKEN` | Authentication token |73 | `GORDON_TOKEN` | Authentication token |
74 74
75 ## Examples75 ## Examples

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