1# Status Command
2
3Show Gordon server status and container health.
4
5## gordon status
6
7Display server configuration and container status for all routes.
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
27Routes: 3
28Auto-Route: true
29Network Isolation: false
30
31Container Status:
32  app.example.com: running
33  api.example.com: running
34  worker.example.com: stopped
35```
36
37### Information Displayed
38
39| Field | Description |
40|-------|-------------|
41| Gordon Domain | Public Gordon domain from configuration |
42| Registry Port | Docker registry port |
43| Server Port | Gordon HTTP proxy port |
44| Routes | Total configured routes |
45| Auto-Route | Whether auto-routing is enabled |
46| Network Isolation | Whether network isolation is enabled |
47| Container Status | Status of each route's container |
48
49### Container States
50
51| State | Description |
52|-------|-------------|
53| running | Container is running and healthy |
54| restarting | Container is in runtime restart backoff or restart cycle |
55| stopped | Container was stopped |
56| exited | Container exited (check logs for errors) |
57| paused | Container is paused |
58| unknown | Unable to determine container state |
59
60## Flags
61
62The status command uses global flags for remote access:
63
64| Flag | Description |
65|------|-------------|
66| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
67| `--token` | Authentication token |
68
69## Environment Variables
70
71| Variable | Description |
72|----------|-------------|
73| `GORDON_REMOTE` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
74| `GORDON_TOKEN` | Authentication token |
75
76## Examples
77
78### Check Local or Remote Status
79
80```bash
81# Local
82gordon status
83
84# Using flags
85gordon status --remote https://gordon.mydomain.com --token $TOKEN
86
87# Using environment variables
88export GORDON_REMOTE=https://gordon.mydomain.com
89export GORDON_TOKEN=your-token
90gordon status
91```
92
93### Quick Health Check
94
95```bash
96# Check if all containers are running
97gordon status --remote https://gordon.mydomain.com --token $TOKEN | grep -E "(running|stopped|exited)"
98```
99
100## Required Permissions (Remote Only)
101
102Remote status calls require `admin:status:read` scope in the authentication token.
103
104```bash
105# Generate token with required scope
106gordon auth token generate --subject admin --scopes admin:status:read
107```
108
109## Related
110
111- [Serve Command](./serve.md)
112- [Routes Command](./routes.md)
113- [Remote CLI Management](/wiki/guides/remote-cli.md)