1# Status Command
2
3Show Gordon server status and the app fleet summary.
4
5## gordon status
6
7Display installation identity plus one status line per app (from desired/active state, no container inspection). Per-service detail lives under `gordon apps show APP` and `gordon apps status APP`.
8
9```bash
10gordon status
11gordon status --remote https://gordon.mydomain.com --token $TOKEN
12```
13
14`gordon status` works in local mode and remote mode.
15
16- Local mode reads status from in-process services.
17- Remote mode reads status from the target admin API.
18
19### Output
20
21```
22Gordon Status
23
24Gordon Domain: gordon.example.com
25Registry Port: 5000
26Server Port: 8088
27Apps: 3
28Network Isolation: false
29
30Container Status:
31  blog: active
32  shop: deploying
33  old-site: stopped
34```
35
36### Information Displayed
37
38| Field | Description |
39|-------|-------------|
40| Gordon Domain | Public Gordon domain from configuration |
41| Registry Port | Docker registry port |
42| Server Port | Gordon admin port |
43| Routes | Total apps in desired/active state |
44| Network Isolation | Whether installation network policy is enabled |
45| Container Status | Fleet status per app (see states below) |
46
47### App States
48
49| State | Description |
50|-------|-------------|
51| active | App deployed and converged on desired state |
52| deploying | Desired state diverges from effective state |
53| pending | App applied but never deployed |
54| stopped | Durable stopped intent (stays stopped across reboot) |
55
56## Flags
57
58The status command uses global flags for remote access:
59
60| Flag | Description |
61|------|-------------|
62| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
63| `--token` | Authentication token |
64
65## Environment Variables
66
67| Variable | Description |
68|----------|-------------|
69| `GORDON_REMOTE` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
70| `GORDON_TOKEN` | Authentication token |
71
72## Examples
73
74### Check Local or Remote Status
75
76```bash
77# Local
78gordon status
79
80# Using flags
81gordon status --remote https://gordon.mydomain.com --token $TOKEN
82
83# Using environment variables
84export GORDON_REMOTE=https://gordon.mydomain.com
85export GORDON_TOKEN=your-token
86gordon status
87```
88
89### Quick Fleet Check
90
91```bash
92# Check for non-converged apps
93gordon status --remote https://gordon.mydomain.com --token $TOKEN | grep -E "(deploying|pending|stopped)"
94```
95
96## Required Permissions (Remote Only)
97
98Remote status calls require `admin:status:read` scope in the authentication token.
99
100```bash
101# Generate token with required scope
102gordon auth token generate --subject admin --scopes admin:status:read
103```
104
105## Related
106
107- [Serve Command](./serve.md)
108- [Apps Commands](./apps.md)
109- [CLI Overview](./index.md)
110- [Remote CLI Management](/wiki/guides/remote-cli.md)