@studiometa/forge-cli 0.2.5 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -47
- package/dist/cli.js +465 -465
- package/dist/cli.js.map +1 -1
- package/dist/commands/backups/handlers.d.ts.map +1 -1
- package/dist/commands/commands/handlers.d.ts.map +1 -1
- package/dist/commands/config.d.ts +1 -1
- package/dist/commands/daemons/handlers.d.ts.map +1 -1
- package/dist/commands/monitors/handlers.d.ts.map +1 -1
- package/dist/commands/recipes/handlers.d.ts.map +1 -1
- package/dist/commands/security-rules/handlers.d.ts.map +1 -1
- package/dist/commands/sites/handlers.d.ts.map +1 -1
- package/dist/commands/ssh-keys/handlers.d.ts.map +1 -1
- package/dist/config.d.ts +1 -1
- package/dist/{error-handler-BahHMt6t.js → error-handler-Byuujxh1.js} +4 -4
- package/dist/error-handler-Byuujxh1.js.map +1 -0
- package/dist/error-handler.d.ts +1 -1
- package/dist/errors.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +4 -4
- package/dist/error-handler-BahHMt6t.js.map +0 -1
package/README.md
CHANGED
|
@@ -23,9 +23,9 @@ Credentials can be provided in three ways (highest priority first):
|
|
|
23
23
|
3. **Config file** (XDG-compliant):
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
|
-
forge
|
|
27
|
-
forge
|
|
28
|
-
forge
|
|
26
|
+
forge config set YOUR_FORGE_TOKEN
|
|
27
|
+
forge config get
|
|
28
|
+
forge config delete
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
| Platform | Config path |
|
|
@@ -37,7 +37,7 @@ forge-cli config delete
|
|
|
37
37
|
## Commands
|
|
38
38
|
|
|
39
39
|
```
|
|
40
|
-
forge
|
|
40
|
+
forge <command> [subcommand] [options]
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
| Command | Alias | Description |
|
|
@@ -65,25 +65,25 @@ forge-cli <command> [subcommand] [options]
|
|
|
65
65
|
| `user` | | Get the authenticated user's profile |
|
|
66
66
|
| `completion` | | Install shell completion (bash, zsh, fish) |
|
|
67
67
|
|
|
68
|
-
Run `forge
|
|
68
|
+
Run `forge <command> --help` for detailed usage of each command.
|
|
69
69
|
|
|
70
70
|
## Quick Start
|
|
71
71
|
|
|
72
72
|
```bash
|
|
73
73
|
# Save your API token
|
|
74
|
-
forge
|
|
74
|
+
forge config set YOUR_FORGE_TOKEN
|
|
75
75
|
|
|
76
76
|
# List all servers
|
|
77
|
-
forge
|
|
77
|
+
forge servers list
|
|
78
78
|
|
|
79
79
|
# List sites on a server
|
|
80
|
-
forge
|
|
80
|
+
forge sites list --server 123
|
|
81
81
|
|
|
82
82
|
# Deploy a site
|
|
83
|
-
forge
|
|
83
|
+
forge deployments deploy --server 123 --site 456
|
|
84
84
|
|
|
85
85
|
# Get environment variables
|
|
86
|
-
forge
|
|
86
|
+
forge env get --server 123 --site 456
|
|
87
87
|
```
|
|
88
88
|
|
|
89
89
|
## Output Formats
|
|
@@ -97,8 +97,8 @@ All list/get commands support `--format`:
|
|
|
97
97
|
| Table | `--format table` | ASCII table |
|
|
98
98
|
|
|
99
99
|
```bash
|
|
100
|
-
forge
|
|
101
|
-
forge
|
|
100
|
+
forge servers list --format json
|
|
101
|
+
forge sites list --server 123 --format table
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
## Command Reference
|
|
@@ -106,31 +106,31 @@ forge-cli sites list --server 123 --format table
|
|
|
106
106
|
### `config` — Manage configuration
|
|
107
107
|
|
|
108
108
|
```bash
|
|
109
|
-
forge
|
|
110
|
-
forge
|
|
111
|
-
forge
|
|
109
|
+
forge config set <token> # Save API token to config file
|
|
110
|
+
forge config get # Show current token (masked)
|
|
111
|
+
forge config delete # Delete stored token
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
### `servers` (`s`) — Manage servers
|
|
115
115
|
|
|
116
116
|
```bash
|
|
117
|
-
forge
|
|
118
|
-
forge
|
|
119
|
-
forge
|
|
117
|
+
forge servers list # List all servers
|
|
118
|
+
forge servers get <id> # Get server details
|
|
119
|
+
forge servers reboot <id> # Reboot a server
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
### `sites` — Manage sites
|
|
123
123
|
|
|
124
124
|
```bash
|
|
125
|
-
forge
|
|
126
|
-
forge
|
|
125
|
+
forge sites list --server <id> # List sites on a server
|
|
126
|
+
forge sites get <site_id> --server <id> # Get site details
|
|
127
127
|
```
|
|
128
128
|
|
|
129
129
|
### `deployments` (`d`) — Manage deployments
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
forge
|
|
133
|
-
forge
|
|
132
|
+
forge deployments list --server <id> --site <id> # List deployments
|
|
133
|
+
forge deployments deploy --server <id> --site <id> # Trigger a deployment
|
|
134
134
|
```
|
|
135
135
|
|
|
136
136
|
The `deploy` command waits for deployment to complete, showing live progress. On completion it prints the deployment log and elapsed time.
|
|
@@ -138,69 +138,69 @@ The `deploy` command waits for deployment to complete, showing live progress. On
|
|
|
138
138
|
### `databases` (`db`) — Manage databases
|
|
139
139
|
|
|
140
140
|
```bash
|
|
141
|
-
forge
|
|
142
|
-
forge
|
|
141
|
+
forge databases list --server <id> # List databases
|
|
142
|
+
forge databases get <db_id> --server <id> # Get database details
|
|
143
143
|
```
|
|
144
144
|
|
|
145
145
|
### `daemons` — Manage background processes
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
|
-
forge
|
|
149
|
-
forge
|
|
150
|
-
forge
|
|
148
|
+
forge daemons list --server <id> # List daemons
|
|
149
|
+
forge daemons get <daemon_id> --server <id> # Get daemon details
|
|
150
|
+
forge daemons restart <daemon_id> --server <id> # Restart a daemon
|
|
151
151
|
```
|
|
152
152
|
|
|
153
153
|
### `env` — Manage environment variables
|
|
154
154
|
|
|
155
155
|
```bash
|
|
156
|
-
forge
|
|
157
|
-
forge
|
|
156
|
+
forge env get --server <id> --site <id> # Get .env content
|
|
157
|
+
forge env update --server <id> --site <id> --content "KEY=value" # Update .env
|
|
158
158
|
```
|
|
159
159
|
|
|
160
160
|
### `nginx` — Manage Nginx configuration
|
|
161
161
|
|
|
162
162
|
```bash
|
|
163
|
-
forge
|
|
164
|
-
forge
|
|
163
|
+
forge nginx get --server <id> --site <id> # Get Nginx config
|
|
164
|
+
forge nginx update --server <id> --site <id> --content "server { ... }" # Update Nginx config
|
|
165
165
|
```
|
|
166
166
|
|
|
167
167
|
### `certificates` (`certs`) — Manage SSL certificates
|
|
168
168
|
|
|
169
169
|
```bash
|
|
170
|
-
forge
|
|
171
|
-
forge
|
|
172
|
-
forge
|
|
170
|
+
forge certificates list --server <id> --site <id> # List certificates
|
|
171
|
+
forge certificates get <cert_id> --server <id> --site <id> # Get certificate details
|
|
172
|
+
forge certificates activate <cert_id> --server <id> --site <id> # Activate a certificate
|
|
173
173
|
```
|
|
174
174
|
|
|
175
175
|
### `firewall-rules` (`fw`) — Manage firewall rules
|
|
176
176
|
|
|
177
177
|
```bash
|
|
178
|
-
forge
|
|
179
|
-
forge
|
|
178
|
+
forge firewall-rules list --server <id> # List firewall rules
|
|
179
|
+
forge firewall-rules get <rule_id> --server <id> # Get rule details
|
|
180
180
|
```
|
|
181
181
|
|
|
182
182
|
### `ssh-keys` — Manage SSH keys
|
|
183
183
|
|
|
184
184
|
```bash
|
|
185
|
-
forge
|
|
186
|
-
forge
|
|
185
|
+
forge ssh-keys list --server <id> # List SSH keys
|
|
186
|
+
forge ssh-keys get <key_id> --server <id> # Get SSH key details
|
|
187
187
|
```
|
|
188
188
|
|
|
189
189
|
### `recipes` — Manage recipes
|
|
190
190
|
|
|
191
191
|
```bash
|
|
192
|
-
forge
|
|
193
|
-
forge
|
|
194
|
-
forge
|
|
192
|
+
forge recipes list # List all recipes
|
|
193
|
+
forge recipes get <id> # Get recipe details
|
|
194
|
+
forge recipes run <id> --servers 123,456 # Run recipe on servers
|
|
195
195
|
```
|
|
196
196
|
|
|
197
197
|
### `completion` — Shell completion
|
|
198
198
|
|
|
199
199
|
```bash
|
|
200
|
-
forge
|
|
201
|
-
forge
|
|
202
|
-
forge
|
|
203
|
-
forge
|
|
200
|
+
forge completion bash # Install Bash completion
|
|
201
|
+
forge completion zsh # Install Zsh completion
|
|
202
|
+
forge completion fish # Install Fish completion
|
|
203
|
+
forge completion bash --print # Print script without installing
|
|
204
204
|
```
|
|
205
205
|
|
|
206
206
|
## Audit Logging
|
|
@@ -229,10 +229,10 @@ The CLI is designed for programmatic use by AI agents:
|
|
|
229
229
|
|
|
230
230
|
```bash
|
|
231
231
|
# Get all servers as JSON
|
|
232
|
-
forge
|
|
232
|
+
forge servers list --format json
|
|
233
233
|
|
|
234
234
|
# Deploy and capture output
|
|
235
|
-
forge
|
|
235
|
+
forge deployments deploy --server 123 --site 456 --format json
|
|
236
236
|
```
|
|
237
237
|
|
|
238
238
|
## Requirements
|