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