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
24Domain: registry.example.com
25Registry Port: 5000
26Server Port: 8080
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| Domain | Registry domain from configuration |
42| Registry Port | Docker registry port |
43| Server Port | Gordon admin API 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| stopped | Container was stopped |
55| exited | Container exited (check logs for errors) |
56| paused | Container is paused |
57| unknown | Unable to determine container state |
58
59## Flags
60
61The status command uses global flags for remote access:
62
63| Flag | Description |
64|------|-------------|
65| `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
66| `--token` | Authentication token |
67
68## Environment Variables
69
70| Variable | Description |
71|----------|-------------|
72| `GORDON_REMOTE` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) |
73| `GORDON_TOKEN` | Authentication token |
74
75## Examples
76
77### Check Local or Remote Status
78
79```bash
80# Local
81gordon status
82
83# Using flags
84gordon status --remote https://gordon.mydomain.com --token $TOKEN
85
86# Using environment variables
87export GORDON_REMOTE=https://gordon.mydomain.com
88export GORDON_TOKEN=your-token
89gordon status
90```
91
92### Quick Health Check
93
94```bash
95# Check if all containers are running
96gordon status --remote https://gordon.mydomain.com --token $TOKEN | grep -E "(running|stopped|exited)"
97```
98
99## Required Permissions (Remote Only)
100
101Remote status calls require `admin:status:read` scope in the authentication token.
102
103```bash
104# Generate token with required scope
105gordon auth token generate --subject admin --scopes admin:status:read
106```
107
108## Related
109
110- [Serve Command](./serve.md)
111- [Routes Command](./routes.md)
112- [Remote CLI Management](/wiki/guides/remote-cli.md)