1# Routes Commands
2
3Manage routes on local or remote Gordon instances.
4
5Remote targeting uses client config or an active remote by default.
6Use `--remote` and `--token` to override. See [CLI Overview](./index.md).
7
8## gordon routes
9
10### Subcommands
11
12| Subcommand | Description |
13|------------|-------------|
14| `list` | List all routes |
15| `add` | Add a new route |
16| `remove` | Remove a route |
17| `deploy` | Deploy a specific route |
18
19---
20
21## gordon routes list
22
23List all configured routes.
24
25```bash
26gordon routes list
27gordon routes list --remote https://gordon.mydomain.com --token $TOKEN
28```
29
30### Output
31
32```
33Domain                    Image                     Status
34--------------------------------------------------------------------------------
35app.example.com           myapp:latest              running
36api.example.com           myapi:v2.1.0              running
37admin.example.com         admin-panel:latest        stopped
38```
39
40---
41
42## gordon routes add
43
44Add a new route.
45
46```bash
47gordon routes add <domain> <image>
48gordon routes add myapp.example.com myapp:latest
49```
50
51### Arguments
52
53| Argument | Description |
54|----------|-------------|
55| `<domain>` | The domain name for the route |
56| `<image>` | The container image to deploy |
57
58### Options
59
60| Option | Description |
61|--------|-------------|
62| `--remote` | Remote Gordon URL |
63| `--token` | Authentication token for remote |
64
65### Examples
66
67```bash
68# Local
69gordon routes add myapp.example.com myapp:latest
70gordon routes add api.example.com myapi:v2.1.0
71
72# Remote (override)
73gordon routes add myapp.example.com myapp:latest --remote https://gordon.mydomain.com --token $TOKEN
74```
75
76---
77
78## gordon routes remove
79
80Remove a route.
81
82```bash
83gordon routes remove <domain>
84gordon routes remove myapp.example.com
85```
86
87### Arguments
88
89| Argument | Description |
90|----------|-------------|
91| `<domain>` | The domain name of the route to remove |
92
93### Options
94
95| Option | Description |
96|--------|-------------|
97| `--remote` | Remote Gordon URL |
98| `--token` | Authentication token for remote |
99
100### Examples
101
102```bash
103# Local
104gordon routes remove myapp.example.com
105
106# Remote (override)
107gordon routes remove myapp.example.com --remote https://gordon.mydomain.com --token $TOKEN
108```
109
110---
111
112## gordon routes deploy
113
114Deploy or redeploy a specific route.
115
116```bash
117gordon routes deploy <domain>
118gordon routes deploy myapp.example.com
119```
120
121### Arguments
122
123| Argument | Description |
124|----------|-------------|
125| `<domain>` | The domain name of the route to deploy |
126
127### Options
128
129| Option | Description |
130|--------|-------------|
131| `--remote` | Remote Gordon URL |
132| `--token` | Authentication token for remote |
133
134### Description
135
136Triggers a fresh image pull and container redeployment for the specified route.
137
138### Examples
139
140```bash
141# Local
142gordon routes deploy myapp.example.com
143
144# Remote (override)
145gordon routes deploy myapp.example.com --remote https://gordon.mydomain.com --token $TOKEN
146```
147
148## Related
149
150- [CLI Overview](./index.md)
151- [Routes Configuration](../config/routes.md)