detached f631ae8

docs: rename start command to serve

commit
f631ae807fa860990dfd8bbbf634e456ee749f74
author
bnema · · 2026-01-16 20:48 UTC
parent
ff74165
signature
unsigned
7 files · +22 -22
M README.md +1 -1
@@ -48,7 +48,7 @@ curl -fsSL https://gordon.bnema.dev/install.sh | sh
4848 # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh
4949
5050 # Start Gordon (generates config on first run)
51-gordon start
51+gordon serve
5252 ```
5353
5454 Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions.
@@ -48,7 +48,7 @@ curl -fsSL https://gordon.bnema.dev/install.sh | sh
48 # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh48 # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh
49 49
50 # Start Gordon (generates config on first run)50 # Start Gordon (generates config on first run)
51-gordon start51+gordon serve
52 ```52 ```
53 53
54 Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions.54 Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions.
M docs/cli/commands.md +12 -12
@@ -6,7 +6,7 @@ Gordon provides a command-line interface for server management, deployment, and
66
77 | Command | Description |
88 |---------|-------------|
9-| `gordon start` | Start the Gordon server |
9+| `gordon serve` | Start the Gordon server |
1010 | `gordon reload` | Reload configuration and sync containers |
1111 | `gordon deploy` | Manually deploy or redeploy a specific route |
1212 | `gordon logs` | Display Gordon process logs |
@@ -17,8 +17,8 @@ Gordon provides a command-line interface for server management, deployment, and
1717
1818 ```bash
1919 # Start Gordon
20-gordon start
21-gordon start --config /path/to/config.toml
20+gordon serve
21+gordon serve --config /path/to/config.toml
2222
2323 # Reload configuration
2424 gordon reload
@@ -50,14 +50,14 @@ gordon auth internal
5050
5151 ---
5252
53-## gordon start
53+## gordon serve
5454
5555 Start the Gordon server with registry and proxy components.
5656
5757 ### Synopsis
5858
5959 ```bash
60-gordon start [options]
60+gordon serve [options]
6161 ```
6262
6363 ### Options
@@ -90,7 +90,7 @@ On first run without a config file, Gordon creates a default configuration at `~
9090
9191 ```bash
9292 # First run - creates default config
93-gordon start
93+gordon serve
9494 # Edit the config, then restart
9595 ```
9696
@@ -98,15 +98,15 @@ gordon start
9898
9999 ```bash
100100 # Basic start
101-gordon start
101+gordon serve
102102
103103 # With custom config
104-gordon start --config /path/to/gordon.toml
105-gordon start -c ./my-config.toml
104+gordon serve --config /path/to/gordon.toml
105+gordon serve -c ./my-config.toml
106106
107107 # With environment override
108-GORDON_SERVER_PORT=8080 gordon start
109-GORDON_LOGGING_LEVEL=debug gordon start
108+GORDON_SERVER_PORT=8080 gordon serve
109+GORDON_LOGGING_LEVEL=debug gordon serve
110110 ```
111111
112112 ### Signals
@@ -132,7 +132,7 @@ Description=Gordon Container Platform
132132 [Service]
133133 Type=simple
134134 Restart=always
135-ExecStart=/usr/local/bin/gordon start
135+ExecStart=/usr/local/bin/gordon serve
136136
137137 [Install]
138138 WantedBy=default.target
@@ -6,7 +6,7 @@ Gordon provides a command-line interface for server management, deployment, and
6 6
7 | Command | Description |7 | Command | Description |
8 |---------|-------------|8 |---------|-------------|
9-| `gordon start` | Start the Gordon server |9+| `gordon serve` | Start the Gordon server |
10 | `gordon reload` | Reload configuration and sync containers |10 | `gordon reload` | Reload configuration and sync containers |
11 | `gordon deploy` | Manually deploy or redeploy a specific route |11 | `gordon deploy` | Manually deploy or redeploy a specific route |
12 | `gordon logs` | Display Gordon process logs |12 | `gordon logs` | Display Gordon process logs |
@@ -17,8 +17,8 @@ Gordon provides a command-line interface for server management, deployment, and
17 17
18 ```bash18 ```bash
19 # Start Gordon19 # Start Gordon
20-gordon start20+gordon serve
21-gordon start --config /path/to/config.toml21+gordon serve --config /path/to/config.toml
22 22
23 # Reload configuration23 # Reload configuration
24 gordon reload24 gordon reload
@@ -50,14 +50,14 @@ gordon auth internal
50 50
51 ---51 ---
52 52
53-## gordon start53+## gordon serve
54 54
55 Start the Gordon server with registry and proxy components.55 Start the Gordon server with registry and proxy components.
56 56
57 ### Synopsis57 ### Synopsis
58 58
59 ```bash59 ```bash
60-gordon start [options]60+gordon serve [options]
61 ```61 ```
62 62
63 ### Options63 ### Options
@@ -90,7 +90,7 @@ On first run without a config file, Gordon creates a default configuration at `~
90 90
91 ```bash91 ```bash
92 # First run - creates default config92 # First run - creates default config
93-gordon start93+gordon serve
94 # Edit the config, then restart94 # Edit the config, then restart
95 ```95 ```
96 96
@@ -98,15 +98,15 @@ gordon start
98 98
99 ```bash99 ```bash
100 # Basic start100 # Basic start
101-gordon start101+gordon serve
102 102
103 # With custom config103 # With custom config
104-gordon start --config /path/to/gordon.toml104+gordon serve --config /path/to/gordon.toml
105-gordon start -c ./my-config.toml105+gordon serve -c ./my-config.toml
106 106
107 # With environment override107 # With environment override
108-GORDON_SERVER_PORT=8080 gordon start108+GORDON_SERVER_PORT=8080 gordon serve
109-GORDON_LOGGING_LEVEL=debug gordon start109+GORDON_LOGGING_LEVEL=debug gordon serve
110 ```110 ```
111 111
112 ### Signals112 ### Signals
@@ -132,7 +132,7 @@ Description=Gordon Container Platform
132 [Service]132 [Service]
133 Type=simple133 Type=simple
134 Restart=always134 Restart=always
135-ExecStart=/usr/local/bin/gordon start135+ExecStart=/usr/local/bin/gordon serve
136 136
137 [Install]137 [Install]
138 WantedBy=default.target138 WantedBy=default.target
M docs/getting-started.md +2 -2
@@ -20,7 +20,7 @@ This script automatically detects your OS and architecture, downloads the approp
2020
2121 ```bash
2222 # First run creates the default config
23-gordon start
23+gordon serve
2424 # Press Ctrl+C to stop
2525 ```
2626
@@ -63,7 +63,7 @@ Description=Gordon Container Platform
6363 [Service]
6464 Type=simple
6565 Restart=always
66-ExecStart=/usr/local/bin/gordon start
66+ExecStart=/usr/local/bin/gordon serve
6767
6868 [Install]
6969 WantedBy=default.target
@@ -20,7 +20,7 @@ This script automatically detects your OS and architecture, downloads the approp
20 20
21 ```bash21 ```bash
22 # First run creates the default config22 # First run creates the default config
23-gordon start23+gordon serve
24 # Press Ctrl+C to stop24 # Press Ctrl+C to stop
25 ```25 ```
26 26
@@ -63,7 +63,7 @@ Description=Gordon Container Platform
63 [Service]63 [Service]
64 Type=simple64 Type=simple
65 Restart=always65 Restart=always
66-ExecStart=/usr/local/bin/gordon start66+ExecStart=/usr/local/bin/gordon serve
67 67
68 [Install]68 [Install]
69 WantedBy=default.target69 WantedBy=default.target
M docs/installation.md +3 -3
@@ -153,7 +153,7 @@ Gordon creates a default configuration on first run:
153153
154154 ```bash
155155 # Run once to generate config, then stop
156-gordon start
156+gordon serve
157157 # Press Ctrl+C
158158
159159 # Edit configuration
@@ -189,7 +189,7 @@ After=podman.socket
189189 Type=simple
190190 Restart=always
191191 RestartSec=5
192-ExecStart=/usr/local/bin/gordon start
192+ExecStart=/usr/local/bin/gordon serve
193193
194194 [Install]
195195 WantedBy=default.target
@@ -219,7 +219,7 @@ Requires=docker.service
219219 Type=simple
220220 Restart=always
221221 RestartSec=5
222-ExecStart=/usr/local/bin/gordon start
222+ExecStart=/usr/local/bin/gordon serve
223223 User=root
224224
225225 [Install]
@@ -153,7 +153,7 @@ Gordon creates a default configuration on first run:
153 153
154 ```bash154 ```bash
155 # Run once to generate config, then stop155 # Run once to generate config, then stop
156-gordon start156+gordon serve
157 # Press Ctrl+C157 # Press Ctrl+C
158 158
159 # Edit configuration159 # Edit configuration
@@ -189,7 +189,7 @@ After=podman.socket
189 Type=simple189 Type=simple
190 Restart=always190 Restart=always
191 RestartSec=5191 RestartSec=5
192-ExecStart=/usr/local/bin/gordon start192+ExecStart=/usr/local/bin/gordon serve
193 193
194 [Install]194 [Install]
195 WantedBy=default.target195 WantedBy=default.target
@@ -219,7 +219,7 @@ Requires=docker.service
219 Type=simple219 Type=simple
220 Restart=always220 Restart=always
221 RestartSec=5221 RestartSec=5
222-ExecStart=/usr/local/bin/gordon start222+ExecStart=/usr/local/bin/gordon serve
223 User=root223 User=root
224 224
225 [Install]225 [Install]
M docs/reference/troubleshooting.md +1 -1
@@ -35,7 +35,7 @@ Common issues and solutions when using Gordon.
3535 ```bash
3636 systemctl --user status gordon
3737 # or
38- pgrep -f "gordon start"
38+ pgrep -f "gordon serve"
3939 ```
4040
4141 2. Check registry port is accessible:
@@ -35,7 +35,7 @@ Common issues and solutions when using Gordon.
35 ```bash35 ```bash
36 systemctl --user status gordon36 systemctl --user status gordon
37 # or37 # or
38- pgrep -f "gordon start"38+ pgrep -f "gordon serve"
39 ```39 ```
40 40
41 2. Check registry port is accessible:41 2. Check registry port is accessible:
M wiki/examples/minimal.md +1 -1
@@ -38,7 +38,7 @@ echo "127.0.0.1 app.local registry.local" | sudo tee -a /etc/hosts
3838 ### 2. Start Gordon
3939
4040 ```bash
41-gordon start
41+gordon serve
4242 ```
4343
4444 ### 3. Build and Deploy
@@ -38,7 +38,7 @@ echo "127.0.0.1 app.local registry.local" | sudo tee -a /etc/hosts
38 ### 2. Start Gordon38 ### 2. Start Gordon
39 39
40 ```bash40 ```bash
41-gordon start41+gordon serve
42 ```42 ```
43 43
44 ### 3. Build and Deploy44 ### 3. Build and Deploy
M wiki/guides/podman-rootless.md +2 -2
@@ -109,7 +109,7 @@ sudo mv gordon /usr/local/bin/
109109 Generate initial config:
110110
111111 ```bash
112-gordon start
112+gordon serve
113113 # Press Ctrl+C after config is created
114114 ```
115115
@@ -138,7 +138,7 @@ After=podman.socket
138138 Type=simple
139139 Restart=always
140140 RestartSec=5
141-ExecStart=/usr/local/bin/gordon start
141+ExecStart=/usr/local/bin/gordon serve
142142
143143 [Install]
144144 WantedBy=default.target
@@ -109,7 +109,7 @@ sudo mv gordon /usr/local/bin/
109 Generate initial config:109 Generate initial config:
110 110
111 ```bash111 ```bash
112-gordon start112+gordon serve
113 # Press Ctrl+C after config is created113 # Press Ctrl+C after config is created
114 ```114 ```
115 115
@@ -138,7 +138,7 @@ After=podman.socket
138 Type=simple138 Type=simple
139 Restart=always139 Restart=always
140 RestartSec=5140 RestartSec=5
141-ExecStart=/usr/local/bin/gordon start141+ExecStart=/usr/local/bin/gordon serve
142 142
143 [Install]143 [Install]
144 WantedBy=default.target144 WantedBy=default.target

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