@chabokan.net/cli 0.8.15 → 0.9.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.
Files changed (54) hide show
  1. package/README.md +520 -66
  2. package/dist/base.d.ts +30 -7
  3. package/dist/base.js +163 -14
  4. package/dist/commands/account/info.d.ts +12 -0
  5. package/dist/commands/account/info.js +40 -0
  6. package/dist/commands/account/list.d.ts +5 -1
  7. package/dist/commands/account/list.js +29 -19
  8. package/dist/commands/account/remove.d.ts +5 -1
  9. package/dist/commands/account/remove.js +23 -12
  10. package/dist/commands/account/use.d.ts +6 -2
  11. package/dist/commands/account/use.js +22 -11
  12. package/dist/commands/cloudserver/create.d.ts +40 -0
  13. package/dist/commands/cloudserver/create.js +242 -0
  14. package/dist/commands/cloudserver/delete.d.ts +14 -0
  15. package/dist/commands/cloudserver/delete.js +65 -0
  16. package/dist/commands/cloudserver/list.d.ts +12 -0
  17. package/dist/commands/cloudserver/list.js +46 -0
  18. package/dist/commands/cloudserver/restart.d.ts +13 -0
  19. package/dist/commands/cloudserver/restart.js +51 -0
  20. package/dist/commands/cloudserver/start.d.ts +13 -0
  21. package/dist/commands/cloudserver/start.js +51 -0
  22. package/dist/commands/cloudserver/stop.d.ts +13 -0
  23. package/dist/commands/cloudserver/stop.js +52 -0
  24. package/dist/commands/deploy.d.ts +13 -3
  25. package/dist/commands/deploy.js +96 -60
  26. package/dist/commands/login.d.ts +8 -4
  27. package/dist/commands/login.js +69 -41
  28. package/dist/commands/service/domain/add.d.ts +15 -0
  29. package/dist/commands/service/domain/add.js +74 -0
  30. package/dist/commands/service/domain/remove.d.ts +15 -0
  31. package/dist/commands/service/domain/remove.js +72 -0
  32. package/dist/commands/service/list.d.ts +5 -1
  33. package/dist/commands/service/list.js +29 -21
  34. package/dist/commands/service/logs.d.ts +6 -2
  35. package/dist/commands/service/logs.js +33 -30
  36. package/dist/commands/service/resize.d.ts +9 -5
  37. package/dist/commands/service/resize.js +73 -69
  38. package/dist/commands/service/restart.d.ts +6 -2
  39. package/dist/commands/service/restart.js +28 -32
  40. package/dist/commands/service/start.d.ts +6 -2
  41. package/dist/commands/service/start.js +29 -31
  42. package/dist/commands/service/stop.d.ts +6 -2
  43. package/dist/commands/service/stop.js +29 -31
  44. package/dist/commands/wallet/list.d.ts +12 -0
  45. package/dist/commands/wallet/list.js +41 -0
  46. package/dist/constants.d.ts +2 -0
  47. package/dist/constants.js +7 -2
  48. package/dist/helper.d.ts +23 -7
  49. package/dist/helper.js +294 -113
  50. package/dist/types.d.ts +28 -8
  51. package/dist/ui.d.ts +23 -0
  52. package/dist/ui.js +70 -0
  53. package/oclif.manifest.json +635 -25
  54. package/package.json +39 -35
package/README.md CHANGED
@@ -1,18 +1,50 @@
1
1
  chabok
2
2
  =================
3
3
 
4
- A new CLI generated with oclif
5
-
4
+ Deploy and manage your [Chabokan](https://chabokan.net) services from the terminal.
6
5
 
6
+ [![Version](https://img.shields.io/npm/v/@chabokan.net/cli.svg)](https://npmjs.org/package/@chabokan.net/cli)
7
+ [![Downloads/week](https://img.shields.io/npm/dw/@chabokan.net/cli.svg)](https://npmjs.org/package/@chabokan.net/cli)
7
8
  [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
8
- [![Version](https://img.shields.io/npm/v/chabok.svg)](https://npmjs.org/package/chabok)
9
- [![Downloads/week](https://img.shields.io/npm/dw/chabok.svg)](https://npmjs.org/package/chabok)
10
-
11
9
 
12
10
  <!-- toc -->
11
+ * [Quick start](#quick-start)
13
12
  * [Usage](#usage)
13
+ * [Environment variables](#environment-variables)
14
14
  * [Commands](#commands)
15
15
  <!-- tocstop -->
16
+ # Quick start
17
+
18
+ ```sh
19
+ # 1. Install
20
+ npm install -g @chabokan.net/cli
21
+
22
+ # 2. Sign in (or use an API token: chabok login -t <token>)
23
+ chabok login
24
+
25
+ # 3. See what you have
26
+ chabok service list
27
+
28
+ # 4. Deploy the project in the current directory
29
+ cd my-project
30
+ chabok deploy
31
+ ```
32
+
33
+ To deploy the same project repeatedly without picking the service each time, add a
34
+ `chabok.json` to its root:
35
+
36
+ ```json
37
+ {
38
+ "service": "my-app"
39
+ }
40
+ ```
41
+
42
+ Then `chabok deploy` alone is enough.
43
+
44
+ Files are excluded from the upload using `.chabokignore`, falling back to
45
+ `.dockerignore` and then `.gitignore`. Run with `CHABOK_DEBUG=true` to see exactly
46
+ what was skipped.
47
+
16
48
  # Usage
17
49
  <!-- usage -->
18
50
  ```sh-session
@@ -20,19 +52,44 @@ $ npm install -g @chabokan.net/cli
20
52
  $ chabok COMMAND
21
53
  running command...
22
54
  $ chabok (--version|-v)
23
- @chabokan.net/cli/0.8.15 darwin-arm64 node-v20.13.1
55
+ @chabokan.net/cli/0.9.0 darwin-arm64 node-v20.13.1
24
56
  $ chabok --help [COMMAND]
25
57
  USAGE
26
58
  $ chabok COMMAND
27
59
  ...
28
60
  ```
29
61
  <!-- usagestop -->
62
+ # Environment variables
63
+
64
+ | Variable | Description |
65
+ | --- | --- |
66
+ | `CHABOK_DEBUG` | Set to `true` to print full error details (status code, endpoint, error code, response body) and ignored-file logs during deploy. |
67
+ | `CHABOK_API_URL` | Override the API base URL. Defaults to `https://apihub.chabokan.net/fa/api/v1/`. |
68
+ | `CHABOK_INSECURE_TLS` | Set to `true` to skip TLS certificate verification. Only for servers with a self-signed certificate — it disables protection against interception, so the CLI warns whenever it is active. |
69
+ | `CHABOK_NO_UPDATE_CHECK` | Set to any value to disable the "new version available" check entirely. Also honours `NO_UPDATE_NOTIFIER`, and it is skipped automatically when `CI` is set. |
70
+ | `CHABOK_NPM_REGISTRY` | npm registry used for the update check. Defaults to `https://registry.npmjs.org`. |
71
+ | `http_proxy` / `https_proxy` | Route requests through an HTTP proxy. |
72
+
73
+ Credentials are stored in `~/.chabok.json` with `0600` permissions (readable only by you).
74
+
75
+ The update check is designed to stay out of your way: it contacts the registry at
76
+ most once every 24 hours, gives up after 1.5 seconds, writes its notice to stderr
77
+ so it never pollutes piped output, and stays silent on any failure. If you are
78
+ offline it costs one 1.5s timeout, and nothing at all on subsequent runs.
79
+
30
80
  # Commands
31
81
  <!-- commands -->
82
+ * [`chabok account info`](#chabok-account-info)
32
83
  * [`chabok account list`](#chabok-account-list)
33
84
  * [`chabok account remove`](#chabok-account-remove)
34
85
  * [`chabok account use`](#chabok-account-use)
35
86
  * [`chabok autocomplete [SHELL]`](#chabok-autocomplete-shell)
87
+ * [`chabok cloudserver create`](#chabok-cloudserver-create)
88
+ * [`chabok cloudserver delete`](#chabok-cloudserver-delete)
89
+ * [`chabok cloudserver list`](#chabok-cloudserver-list)
90
+ * [`chabok cloudserver restart`](#chabok-cloudserver-restart)
91
+ * [`chabok cloudserver start`](#chabok-cloudserver-start)
92
+ * [`chabok cloudserver stop`](#chabok-cloudserver-stop)
36
93
  * [`chabok deploy`](#chabok-deploy)
37
94
  * [`chabok help [COMMAND]`](#chabok-help-command)
38
95
  * [`chabok login`](#chabok-login)
@@ -46,6 +103,8 @@ USAGE
46
103
  * [`chabok plugins uninstall [PLUGIN]`](#chabok-plugins-uninstall-plugin)
47
104
  * [`chabok plugins unlink [PLUGIN]`](#chabok-plugins-unlink-plugin)
48
105
  * [`chabok plugins update`](#chabok-plugins-update)
106
+ * [`chabok service domain add`](#chabok-service-domain-add)
107
+ * [`chabok service domain remove`](#chabok-service-domain-remove)
49
108
  * [`chabok service list`](#chabok-service-list)
50
109
  * [`chabok service logs`](#chabok-service-logs)
51
110
  * [`chabok service resize`](#chabok-service-resize)
@@ -53,10 +112,33 @@ USAGE
53
112
  * [`chabok service start`](#chabok-service-start)
54
113
  * [`chabok service stop`](#chabok-service-stop)
55
114
  * [`chabok version`](#chabok-version)
115
+ * [`chabok wallet list`](#chabok-wallet-list)
116
+
117
+ ## `chabok account info`
118
+
119
+ show information about the active account
120
+
121
+ ```
122
+ USAGE
123
+ $ chabok account info [-h]
124
+
125
+ FLAGS
126
+ -h, --help Show CLI help.
127
+
128
+ DESCRIPTION
129
+ show information about the active account
130
+
131
+ EXAMPLES
132
+ Show the active account's details
133
+
134
+ $ chabok account info
135
+ ```
136
+
137
+ _See code: [src/commands/account/info.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/account/info.ts)_
56
138
 
57
139
  ## `chabok account list`
58
140
 
59
- show accounts list
141
+ list the accounts you are logged in to
60
142
 
61
143
  ```
62
144
  USAGE
@@ -66,14 +148,19 @@ FLAGS
66
148
  -h, --help Show CLI help.
67
149
 
68
150
  DESCRIPTION
69
- show accounts list
151
+ list the accounts you are logged in to
152
+
153
+ EXAMPLES
154
+ Show every logged-in account and which one is active
155
+
156
+ $ chabok account list
70
157
  ```
71
158
 
72
- _See code: [src/commands/account/list.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/account/list.ts)_
159
+ _See code: [src/commands/account/list.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/account/list.ts)_
73
160
 
74
161
  ## `chabok account remove`
75
162
 
76
- remove account from list
163
+ sign out of an account and forget its stored token
77
164
 
78
165
  ```
79
166
  USAGE
@@ -83,14 +170,19 @@ FLAGS
83
170
  -h, --help Show CLI help.
84
171
 
85
172
  DESCRIPTION
86
- remove account from list
173
+ sign out of an account and forget its stored token
174
+
175
+ EXAMPLES
176
+ Pick the account to sign out of
177
+
178
+ $ chabok account remove
87
179
  ```
88
180
 
89
- _See code: [src/commands/account/remove.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/account/remove.ts)_
181
+ _See code: [src/commands/account/remove.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/account/remove.ts)_
90
182
 
91
183
  ## `chabok account use`
92
184
 
93
- switch your default user between logged in users
185
+ switch the active account
94
186
 
95
187
  ```
96
188
  USAGE
@@ -98,13 +190,22 @@ USAGE
98
190
 
99
191
  FLAGS
100
192
  -h, --help Show CLI help.
101
- -u, --user=<value> default user
193
+ -u, --user=<value> email of the account to switch to
102
194
 
103
195
  DESCRIPTION
104
- switch your default user between logged in users
196
+ switch the active account
197
+
198
+ EXAMPLES
199
+ Pick the account to switch to from a list
200
+
201
+ $ chabok account use
202
+
203
+ Switch to a specific account without prompting
204
+
205
+ $ chabok account use --user me@example.com
105
206
  ```
106
207
 
107
- _See code: [src/commands/account/use.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/account/use.ts)_
208
+ _See code: [src/commands/account/use.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/account/use.ts)_
108
209
 
109
210
  ## `chabok autocomplete [SHELL]`
110
211
 
@@ -115,7 +216,7 @@ USAGE
115
216
  $ chabok autocomplete [SHELL] [-r]
116
217
 
117
218
  ARGUMENTS
118
- SHELL (zsh|bash|powershell) Shell type
219
+ [SHELL] (zsh|bash|powershell) Shell type
119
220
 
120
221
  FLAGS
121
222
  -r, --refresh-cache Refresh cache (ignores displaying instructions)
@@ -135,11 +236,170 @@ EXAMPLES
135
236
  $ chabok autocomplete --refresh-cache
136
237
  ```
137
238
 
138
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.31/src/commands/autocomplete/index.ts)_
239
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.53/src/commands/autocomplete/index.ts)_
240
+
241
+ ## `chabok cloudserver create`
242
+
243
+ create a new cloud server (VPS) — walks through provider, location, plan, OS and wallet
244
+
245
+ ```
246
+ USAGE
247
+ $ chabok cloudserver create [-h] [--hostname <value>] [--wallet <value>]
248
+
249
+ FLAGS
250
+ -h, --help Show CLI help.
251
+ --hostname=<value> hostname for the new cloud server
252
+ --wallet=<value> name of the wallet to pay from
253
+
254
+ DESCRIPTION
255
+ create a new cloud server (VPS) — walks through provider, location, plan, OS and wallet
256
+
257
+ EXAMPLES
258
+ Create a cloud server, choosing every option interactively
259
+
260
+ $ chabok cloudserver create
261
+
262
+ Skip the hostname prompt
263
+
264
+ $ chabok cloudserver create --hostname my-vps
265
+ ```
266
+
267
+ _See code: [src/commands/cloudserver/create.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/create.ts)_
268
+
269
+ ## `chabok cloudserver delete`
270
+
271
+ permanently delete a cloud server
272
+
273
+ ```
274
+ USAGE
275
+ $ chabok cloudserver delete [-h] [--hostname <value>] [-y]
276
+
277
+ FLAGS
278
+ -h, --help Show CLI help.
279
+ -y, --yes skip the confirmation prompt
280
+ --hostname=<value> hostname of the cloud server to delete
281
+
282
+ DESCRIPTION
283
+ permanently delete a cloud server
284
+
285
+ EXAMPLES
286
+ Pick a cloud server from an interactive list, then confirm
287
+
288
+ $ chabok cloudserver delete
289
+
290
+ Delete a specific cloud server without a confirmation prompt
291
+
292
+ $ chabok cloudserver delete --hostname my-vps --yes
293
+ ```
294
+
295
+ _See code: [src/commands/cloudserver/delete.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/delete.ts)_
296
+
297
+ ## `chabok cloudserver list`
298
+
299
+ list the cloud servers (VPS) on your account
300
+
301
+ ```
302
+ USAGE
303
+ $ chabok cloudserver list [-h]
304
+
305
+ FLAGS
306
+ -h, --help Show CLI help.
307
+
308
+ DESCRIPTION
309
+ list the cloud servers (VPS) on your account
310
+
311
+ EXAMPLES
312
+ List every cloud server on the active account
313
+
314
+ $ chabok cloudserver list
315
+ ```
316
+
317
+ _See code: [src/commands/cloudserver/list.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/list.ts)_
318
+
319
+ ## `chabok cloudserver restart`
320
+
321
+ restart a cloud server
322
+
323
+ ```
324
+ USAGE
325
+ $ chabok cloudserver restart [-h] [--hostname <value>]
326
+
327
+ FLAGS
328
+ -h, --help Show CLI help.
329
+ --hostname=<value> hostname of the cloud server to restart
330
+
331
+ DESCRIPTION
332
+ restart a cloud server
333
+
334
+ EXAMPLES
335
+ Pick a cloud server from an interactive list
336
+
337
+ $ chabok cloudserver restart
338
+
339
+ Restart a specific cloud server by hostname
340
+
341
+ $ chabok cloudserver restart --hostname my-vps
342
+ ```
343
+
344
+ _See code: [src/commands/cloudserver/restart.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/restart.ts)_
345
+
346
+ ## `chabok cloudserver start`
347
+
348
+ turn on a cloud server
349
+
350
+ ```
351
+ USAGE
352
+ $ chabok cloudserver start [-h] [--hostname <value>]
353
+
354
+ FLAGS
355
+ -h, --help Show CLI help.
356
+ --hostname=<value> hostname of the cloud server to turn on
357
+
358
+ DESCRIPTION
359
+ turn on a cloud server
360
+
361
+ EXAMPLES
362
+ Pick a cloud server from an interactive list
363
+
364
+ $ chabok cloudserver start
365
+
366
+ Turn on a specific cloud server by hostname
367
+
368
+ $ chabok cloudserver start --hostname my-vps
369
+ ```
370
+
371
+ _See code: [src/commands/cloudserver/start.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/start.ts)_
372
+
373
+ ## `chabok cloudserver stop`
374
+
375
+ turn off a cloud server
376
+
377
+ ```
378
+ USAGE
379
+ $ chabok cloudserver stop [-h] [--hostname <value>]
380
+
381
+ FLAGS
382
+ -h, --help Show CLI help.
383
+ --hostname=<value> hostname of the cloud server to turn off
384
+
385
+ DESCRIPTION
386
+ turn off a cloud server
387
+
388
+ EXAMPLES
389
+ Pick a cloud server from an interactive list
390
+
391
+ $ chabok cloudserver stop
392
+
393
+ Turn off a specific cloud server by hostname
394
+
395
+ $ chabok cloudserver stop --hostname my-vps
396
+ ```
397
+
398
+ _See code: [src/commands/cloudserver/stop.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/cloudserver/stop.ts)_
139
399
 
140
400
  ## `chabok deploy`
141
401
 
142
- this command help you build and deploy your service to chabokan in easy way.
402
+ upload the current project and deploy it to a service
143
403
 
144
404
  ```
145
405
  USAGE
@@ -147,14 +407,35 @@ USAGE
147
407
 
148
408
  FLAGS
149
409
  -h, --help Show CLI help.
150
- -p, --path=<value> service path in your computer
151
- -s, --service=<value> service name
410
+ -p, --path=<value> project directory to upload (defaults to the current directory)
411
+ -s, --service=<value> name of the service to deploy to
152
412
 
153
413
  DESCRIPTION
154
- this command help you build and deploy your service to chabokan in easy way.
414
+ upload the current project and deploy it to a service
415
+
416
+ EXAMPLES
417
+ Deploy the current directory, picking the service from a list
418
+
419
+ $ chabok deploy
420
+
421
+ Deploy the current directory to a named service
422
+
423
+ $ chabok deploy --service my-app
424
+
425
+ Deploy a project that lives somewhere else
426
+
427
+ $ chabok deploy --path ./apps/api --service my-api
428
+
429
+ Pin the target service in the project, so plain `deploy` always works
430
+
431
+ echo '{"service": "my-app"}' > chabok.json && chabok deploy
432
+
433
+ See exactly which files are excluded from the upload
434
+
435
+ CHABOK_DEBUG=true chabok deploy -s my-app
155
436
  ```
156
437
 
157
- _See code: [src/commands/deploy.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/deploy.ts)_
438
+ _See code: [src/commands/deploy.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/deploy.ts)_
158
439
 
159
440
  ## `chabok help [COMMAND]`
160
441
 
@@ -165,7 +446,7 @@ USAGE
165
446
  $ chabok help [COMMAND...] [-n]
166
447
 
167
448
  ARGUMENTS
168
- COMMAND... Command to show help for.
449
+ [COMMAND...] Command to show help for.
169
450
 
170
451
  FLAGS
171
452
  -n, --nested-commands Include all nested commands in the output.
@@ -174,11 +455,11 @@ DESCRIPTION
174
455
  Display help for chabok.
175
456
  ```
176
457
 
177
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
458
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.53/src/commands/help.ts)_
178
459
 
179
460
  ## `chabok login`
180
461
 
181
- login to hub.chabokan.net account
462
+ sign in to your hub.chabokan.net account
182
463
 
183
464
  ```
184
465
  USAGE
@@ -186,15 +467,32 @@ USAGE
186
467
 
187
468
  FLAGS
188
469
  -h, --help Show CLI help.
189
- -p, --password=<value> your password
190
- -t, --token=<value> login with api token
191
- -u, --username=<value> your username
470
+ -p, --password=<value> your password (prompted for if omitted)
471
+ -t, --token=<value> API token, for non-interactive sign-in
472
+ -u, --username=<value> your email address
192
473
 
193
474
  DESCRIPTION
194
- login to hub.chabokan.net account
475
+ sign in to your hub.chabokan.net account
476
+
477
+ EXAMPLES
478
+ Sign in interactively (prompts for email and password)
479
+
480
+ $ chabok login
481
+
482
+ Sign in with an API token — the right choice for CI
483
+
484
+ $ chabok login --token <your-api-token>
485
+
486
+ Pass the email up front and be prompted only for the password
487
+
488
+ $ chabok login --email me@example.com
489
+
490
+ Add a second account (both stay signed in; switch with `account use`)
491
+
492
+ $ chabok login --email other@example.com
195
493
  ```
196
494
 
197
- _See code: [src/commands/login.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/login.ts)_
495
+ _See code: [src/commands/login.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/login.ts)_
198
496
 
199
497
  ## `chabok plugins`
200
498
 
@@ -217,7 +515,7 @@ EXAMPLES
217
515
  $ chabok plugins
218
516
  ```
219
517
 
220
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/index.ts)_
518
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/index.ts)_
221
519
 
222
520
  ## `chabok plugins add PLUGIN`
223
521
 
@@ -291,7 +589,7 @@ EXAMPLES
291
589
  $ chabok plugins inspect myplugin
292
590
  ```
293
591
 
294
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/inspect.ts)_
592
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/inspect.ts)_
295
593
 
296
594
  ## `chabok plugins install PLUGIN`
297
595
 
@@ -340,7 +638,7 @@ EXAMPLES
340
638
  $ chabok plugins install someuser/someplugin
341
639
  ```
342
640
 
343
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/install.ts)_
641
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/install.ts)_
344
642
 
345
643
  ## `chabok plugins link PATH`
346
644
 
@@ -371,7 +669,7 @@ EXAMPLES
371
669
  $ chabok plugins link myplugin
372
670
  ```
373
671
 
374
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/link.ts)_
672
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/link.ts)_
375
673
 
376
674
  ## `chabok plugins remove [PLUGIN]`
377
675
 
@@ -382,7 +680,7 @@ USAGE
382
680
  $ chabok plugins remove [PLUGIN...] [-h] [-v]
383
681
 
384
682
  ARGUMENTS
385
- PLUGIN... plugin to uninstall
683
+ [PLUGIN...] plugin to uninstall
386
684
 
387
685
  FLAGS
388
686
  -h, --help Show CLI help.
@@ -412,7 +710,7 @@ FLAGS
412
710
  --reinstall Reinstall all plugins after uninstalling.
413
711
  ```
414
712
 
415
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/reset.ts)_
713
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/reset.ts)_
416
714
 
417
715
  ## `chabok plugins uninstall [PLUGIN]`
418
716
 
@@ -423,7 +721,7 @@ USAGE
423
721
  $ chabok plugins uninstall [PLUGIN...] [-h] [-v]
424
722
 
425
723
  ARGUMENTS
426
- PLUGIN... plugin to uninstall
724
+ [PLUGIN...] plugin to uninstall
427
725
 
428
726
  FLAGS
429
727
  -h, --help Show CLI help.
@@ -440,7 +738,7 @@ EXAMPLES
440
738
  $ chabok plugins uninstall myplugin
441
739
  ```
442
740
 
443
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/uninstall.ts)_
741
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/uninstall.ts)_
444
742
 
445
743
  ## `chabok plugins unlink [PLUGIN]`
446
744
 
@@ -451,7 +749,7 @@ USAGE
451
749
  $ chabok plugins unlink [PLUGIN...] [-h] [-v]
452
750
 
453
751
  ARGUMENTS
454
- PLUGIN... plugin to uninstall
752
+ [PLUGIN...] plugin to uninstall
455
753
 
456
754
  FLAGS
457
755
  -h, --help Show CLI help.
@@ -484,11 +782,67 @@ DESCRIPTION
484
782
  Update installed plugins.
485
783
  ```
486
784
 
487
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/update.ts)_
785
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.85/src/commands/plugins/update.ts)_
786
+
787
+ ## `chabok service domain add`
788
+
789
+ connect a custom domain to a service
790
+
791
+ ```
792
+ USAGE
793
+ $ chabok service domain add [-h] [-s <value>] [-d <value>]
794
+
795
+ FLAGS
796
+ -d, --domain=<value> domain name to connect, e.g. www.example.com
797
+ -h, --help Show CLI help.
798
+ -s, --service=<value> name of the service to connect the domain to
799
+
800
+ DESCRIPTION
801
+ connect a custom domain to a service
802
+
803
+ EXAMPLES
804
+ Pick the service and enter the domain interactively
805
+
806
+ $ chabok service domain add
807
+
808
+ Connect a domain in one non-interactive command
809
+
810
+ $ chabok service domain add -s my-app -d www.example.com
811
+ ```
812
+
813
+ _See code: [src/commands/service/domain/add.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/domain/add.ts)_
814
+
815
+ ## `chabok service domain remove`
816
+
817
+ disconnect a custom domain from a service
818
+
819
+ ```
820
+ USAGE
821
+ $ chabok service domain remove [-h] [-s <value>] [-d <value>]
822
+
823
+ FLAGS
824
+ -d, --domain=<value> domain name to disconnect
825
+ -h, --help Show CLI help.
826
+ -s, --service=<value> name of the service the domain is connected to
827
+
828
+ DESCRIPTION
829
+ disconnect a custom domain from a service
830
+
831
+ EXAMPLES
832
+ Pick the service and enter the domain interactively
833
+
834
+ $ chabok service domain remove
835
+
836
+ Disconnect a domain in one non-interactive command
837
+
838
+ $ chabok service domain remove -s my-app -d www.example.com
839
+ ```
840
+
841
+ _See code: [src/commands/service/domain/remove.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/domain/remove.ts)_
488
842
 
489
843
  ## `chabok service list`
490
844
 
491
- show account services list
845
+ list the services on your account
492
846
 
493
847
  ```
494
848
  USAGE
@@ -498,14 +852,23 @@ FLAGS
498
852
  -h, --help Show CLI help.
499
853
 
500
854
  DESCRIPTION
501
- show account services list
855
+ list the services on your account
856
+
857
+ EXAMPLES
858
+ List every service on the active account
859
+
860
+ $ chabok service list
861
+
862
+ Switch account first, then list that account’s services
863
+
864
+ $ chabok account use -u me@example.com && chabok service list
502
865
  ```
503
866
 
504
- _See code: [src/commands/service/list.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/list.ts)_
867
+ _See code: [src/commands/service/list.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/list.ts)_
505
868
 
506
869
  ## `chabok service logs`
507
870
 
508
- read latest logs from service
871
+ read the latest logs from a service
509
872
 
510
873
  ```
511
874
  USAGE
@@ -513,34 +876,64 @@ USAGE
513
876
 
514
877
  FLAGS
515
878
  -h, --help Show CLI help.
516
- -s, --service=<value> service name
879
+ -s, --service=<value> name of the service to read logs from
517
880
 
518
881
  DESCRIPTION
519
- read latest logs from service
882
+ read the latest logs from a service
883
+
884
+ EXAMPLES
885
+ Pick a service from an interactive list
886
+
887
+ $ chabok service logs
888
+
889
+ Read logs for a specific service
890
+
891
+ $ chabok service logs --service my-app
892
+
893
+ Search the logs for errors
894
+
895
+ $ chabok service logs -s my-app | grep -i error
896
+
897
+ Save the logs to a file
898
+
899
+ $ chabok service logs -s my-app > my-app.log
520
900
  ```
521
901
 
522
- _See code: [src/commands/service/logs.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/logs.ts)_
902
+ _See code: [src/commands/service/logs.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/logs.ts)_
523
903
 
524
904
  ## `chabok service resize`
525
905
 
526
- resize a service
906
+ change the RAM, CPU and disk allocated to a service
527
907
 
528
908
  ```
529
909
  USAGE
530
910
  $ chabok service resize [-h] [-s <value>] [-r <value>] [-c <value>] [-d <value>]
531
911
 
532
912
  FLAGS
533
- -c, --cpu=<value> CPU
534
- -d, --disk=<value> DISK
913
+ -c, --cpu=<value> CPU cores, in steps of 0.5 (e.g. 0.5, 1, 2)
914
+ -d, --disk=<value> disk in GB, in steps of 5 (e.g. 5, 10, 30)
535
915
  -h, --help Show CLI help.
536
- -r, --ram=<value> RAM
537
- -s, --service=<value> service name
916
+ -r, --ram=<value> RAM in GB, in steps of 0.5 (e.g. 0.5, 1, 2)
917
+ -s, --service=<value> name of the service to resize
538
918
 
539
919
  DESCRIPTION
540
- resize a service
920
+ change the RAM, CPU and disk allocated to a service
921
+
922
+ EXAMPLES
923
+ Choose the service and every resource interactively
924
+
925
+ $ chabok service resize
926
+
927
+ Resize a service in one non-interactive command
928
+
929
+ $ chabok service resize -s my-app --ram 2 --cpu 1 --disk 10
930
+
931
+ Set only the RAM and pick the rest from the prompts
932
+
933
+ $ chabok service resize -s my-app --ram 4
541
934
  ```
542
935
 
543
- _See code: [src/commands/service/resize.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/resize.ts)_
936
+ _See code: [src/commands/service/resize.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/resize.ts)_
544
937
 
545
938
  ## `chabok service restart`
546
939
 
@@ -552,17 +945,30 @@ USAGE
552
945
 
553
946
  FLAGS
554
947
  -h, --help Show CLI help.
555
- -s, --service=<value> service name
948
+ -s, --service=<value> name of the service to restart
556
949
 
557
950
  DESCRIPTION
558
951
  restart a service
952
+
953
+ EXAMPLES
954
+ Pick a service from an interactive list
955
+
956
+ $ chabok service restart
957
+
958
+ Restart a specific service by name
959
+
960
+ $ chabok service restart --service my-app
961
+
962
+ Restart, then tail the logs to confirm it came back up
963
+
964
+ $ chabok service restart -s my-app && chabok service logs -s my-app
559
965
  ```
560
966
 
561
- _See code: [src/commands/service/restart.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/restart.ts)_
967
+ _See code: [src/commands/service/restart.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/restart.ts)_
562
968
 
563
969
  ## `chabok service start`
564
970
 
565
- start a service
971
+ start a stopped service
566
972
 
567
973
  ```
568
974
  USAGE
@@ -570,17 +976,30 @@ USAGE
570
976
 
571
977
  FLAGS
572
978
  -h, --help Show CLI help.
573
- -s, --service=<value> service name
979
+ -s, --service=<value> name of the service to start
574
980
 
575
981
  DESCRIPTION
576
- start a service
982
+ start a stopped service
983
+
984
+ EXAMPLES
985
+ Pick a service from an interactive list
986
+
987
+ $ chabok service start
988
+
989
+ Start a specific service by name
990
+
991
+ $ chabok service start --service my-app
992
+
993
+ Same, using the short flag
994
+
995
+ $ chabok service start -s my-app
577
996
  ```
578
997
 
579
- _See code: [src/commands/service/start.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/start.ts)_
998
+ _See code: [src/commands/service/start.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/start.ts)_
580
999
 
581
1000
  ## `chabok service stop`
582
1001
 
583
- stop a service
1002
+ stop a running service
584
1003
 
585
1004
  ```
586
1005
  USAGE
@@ -588,13 +1007,26 @@ USAGE
588
1007
 
589
1008
  FLAGS
590
1009
  -h, --help Show CLI help.
591
- -s, --service=<value> service name
1010
+ -s, --service=<value> name of the service to stop
592
1011
 
593
1012
  DESCRIPTION
594
- stop a service
1013
+ stop a running service
1014
+
1015
+ EXAMPLES
1016
+ Pick a service from an interactive list
1017
+
1018
+ $ chabok service stop
1019
+
1020
+ Stop a specific service by name
1021
+
1022
+ $ chabok service stop --service my-app
1023
+
1024
+ Same, using the short flag
1025
+
1026
+ $ chabok service stop -s my-app
595
1027
  ```
596
1028
 
597
- _See code: [src/commands/service/stop.ts](https://github.com/chabokan/cli/blob/v0.8.15/src/commands/service/stop.ts)_
1029
+ _See code: [src/commands/service/stop.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/service/stop.ts)_
598
1030
 
599
1031
  ## `chabok version`
600
1032
 
@@ -614,5 +1046,27 @@ FLAG DESCRIPTIONS
614
1046
  Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
615
1047
  ```
616
1048
 
617
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.30/src/commands/version.ts)_
1049
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.51/src/commands/version.ts)_
1050
+
1051
+ ## `chabok wallet list`
1052
+
1053
+ list the wallets on your account
1054
+
1055
+ ```
1056
+ USAGE
1057
+ $ chabok wallet list [-h]
1058
+
1059
+ FLAGS
1060
+ -h, --help Show CLI help.
1061
+
1062
+ DESCRIPTION
1063
+ list the wallets on your account
1064
+
1065
+ EXAMPLES
1066
+ Show every wallet and its balance
1067
+
1068
+ $ chabok wallet list
1069
+ ```
1070
+
1071
+ _See code: [src/commands/wallet/list.ts](https://github.com/chabokan/cli/blob/v0.9.0/src/commands/wallet/list.ts)_
618
1072
  <!-- commandsstop -->