@chabokan.net/cli 0.8.7 → 0.8.8

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 CHANGED
@@ -1,11 +1,13 @@
1
- chabok CLI
1
+ chabok
2
2
  =================
3
3
 
4
- The command line interface for chabokan.net
4
+ A new CLI generated with oclif
5
+
6
+
7
+ [![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)
5
10
 
6
- [![Version](https://img.shields.io/npm/v/@chabokan.net/cli.svg)](https://npmjs.com/package/@chabokan.net/cli)
7
- [![Downloads/week](https://img.shields.io/npm/dw/@chabokan.net/cli.svg)](https://npmjs.org/package/@chabokan.net/cli)
8
- [![License](https://img.shields.io/npm/l/@chabokan.net/cli.svg)](https://github.com/chabokan/cli/blob/master/package.json)
9
11
 
10
12
  <!-- toc -->
11
13
  * [Usage](#usage)
@@ -18,7 +20,7 @@ $ npm install -g @chabokan.net/cli
18
20
  $ chabok COMMAND
19
21
  running command...
20
22
  $ chabok (--version|-v)
21
- @chabokan.net/cli/0.8.7 darwin-arm64 node-v20.13.1
23
+ @chabokan.net/cli/0.8.8 darwin-arm64 node-v20.13.1
22
24
  $ chabok --help [COMMAND]
23
25
  USAGE
24
26
  $ chabok COMMAND
@@ -27,272 +29,359 @@ USAGE
27
29
  <!-- usagestop -->
28
30
  # Commands
29
31
  <!-- commands -->
30
- * [`chabok account list`](#chabok-account-list)
31
- * [`chabok account remove`](#chabok-account-remove)
32
- * [`chabok account use`](#chabok-account-use)
33
32
  * [`chabok autocomplete [SHELL]`](#chabok-autocomplete-shell)
34
- * [`chabok deploy`](#chabok-deploy)
35
33
  * [`chabok help [COMMAND]`](#chabok-help-command)
36
- * [`chabok login`](#chabok-login)
37
- * [`chabok service list`](#chabok-service-list)
38
- * [`chabok service logs`](#chabok-service-logs)
39
- * [`chabok service resize`](#chabok-service-resize)
40
- * [`chabok service restart`](#chabok-service-restart)
41
- * [`chabok service start`](#chabok-service-start)
42
- * [`chabok service stop`](#chabok-service-stop)
34
+ * [`chabok plugins`](#chabok-plugins)
35
+ * [`chabok plugins add PLUGIN`](#chabok-plugins-add-plugin)
36
+ * [`chabok plugins:inspect PLUGIN...`](#chabok-pluginsinspect-plugin)
37
+ * [`chabok plugins install PLUGIN`](#chabok-plugins-install-plugin)
38
+ * [`chabok plugins link PATH`](#chabok-plugins-link-path)
39
+ * [`chabok plugins remove [PLUGIN]`](#chabok-plugins-remove-plugin)
40
+ * [`chabok plugins reset`](#chabok-plugins-reset)
41
+ * [`chabok plugins uninstall [PLUGIN]`](#chabok-plugins-uninstall-plugin)
42
+ * [`chabok plugins unlink [PLUGIN]`](#chabok-plugins-unlink-plugin)
43
+ * [`chabok plugins update`](#chabok-plugins-update)
43
44
  * [`chabok version`](#chabok-version)
44
45
 
45
- ## `chabok account list`
46
+ ## `chabok autocomplete [SHELL]`
46
47
 
47
- show accounts list
48
+ Display autocomplete installation instructions.
48
49
 
49
50
  ```
50
51
  USAGE
51
- $ chabok account list [-h]
52
+ $ chabok autocomplete [SHELL] [-r]
53
+
54
+ ARGUMENTS
55
+ SHELL (zsh|bash|powershell) Shell type
52
56
 
53
57
  FLAGS
54
- -h, --help Show CLI help.
58
+ -r, --refresh-cache Refresh cache (ignores displaying instructions)
55
59
 
56
60
  DESCRIPTION
57
- show accounts list
61
+ Display autocomplete installation instructions.
62
+
63
+ EXAMPLES
64
+ $ chabok autocomplete
65
+
66
+ $ chabok autocomplete bash
67
+
68
+ $ chabok autocomplete zsh
69
+
70
+ $ chabok autocomplete powershell
71
+
72
+ $ chabok autocomplete --refresh-cache
58
73
  ```
59
74
 
60
- _See code: [src/commands/account/list.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/account/list.ts)_
75
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.18/src/commands/autocomplete/index.ts)_
61
76
 
62
- ## `chabok account remove`
77
+ ## `chabok help [COMMAND]`
63
78
 
64
- remove account from list
79
+ Display help for chabok.
65
80
 
66
81
  ```
67
82
  USAGE
68
- $ chabok account remove [-h]
83
+ $ chabok help [COMMAND...] [-n]
84
+
85
+ ARGUMENTS
86
+ COMMAND... Command to show help for.
69
87
 
70
88
  FLAGS
71
- -h, --help Show CLI help.
89
+ -n, --nested-commands Include all nested commands in the output.
72
90
 
73
91
  DESCRIPTION
74
- remove account from list
92
+ Display help for chabok.
75
93
  ```
76
94
 
77
- _See code: [src/commands/account/remove.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/account/remove.ts)_
95
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
78
96
 
79
- ## `chabok account use`
97
+ ## `chabok plugins`
80
98
 
81
- switch your default user between logged in users
99
+ List installed plugins.
82
100
 
83
101
  ```
84
102
  USAGE
85
- $ chabok account use [-h] [-u <value>]
103
+ $ chabok plugins [--json] [--core]
86
104
 
87
105
  FLAGS
88
- -h, --help Show CLI help.
89
- -u, --user=<value> default user
106
+ --core Show core plugins.
107
+
108
+ GLOBAL FLAGS
109
+ --json Format output as json.
90
110
 
91
111
  DESCRIPTION
92
- switch your default user between logged in users
112
+ List installed plugins.
113
+
114
+ EXAMPLES
115
+ $ chabok plugins
93
116
  ```
94
117
 
95
- _See code: [src/commands/account/use.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/account/use.ts)_
118
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/index.ts)_
96
119
 
97
- ## `chabok autocomplete [SHELL]`
120
+ ## `chabok plugins add PLUGIN`
98
121
 
99
- Display autocomplete installation instructions.
122
+ Installs a plugin into chabok.
100
123
 
101
124
  ```
102
125
  USAGE
103
- $ chabok autocomplete [SHELL] [-r]
126
+ $ chabok plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
104
127
 
105
128
  ARGUMENTS
106
- SHELL (zsh|bash|powershell) Shell type
129
+ PLUGIN... Plugin to install.
107
130
 
108
131
  FLAGS
109
- -r, --refresh-cache Refresh cache (ignores displaying instructions)
132
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
133
+ -h, --help Show CLI help.
134
+ -s, --silent Silences npm output.
135
+ -v, --verbose Show verbose npm output.
136
+
137
+ GLOBAL FLAGS
138
+ --json Format output as json.
110
139
 
111
140
  DESCRIPTION
112
- Display autocomplete installation instructions.
141
+ Installs a plugin into chabok.
142
+
143
+ Uses bundled npm executable to install plugins into /Users/mohammad/.local/share/@chabokan.net/cli
144
+
145
+ Installation of a user-installed plugin will override a core plugin.
146
+
147
+ Use the CHABOK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
148
+ Use the CHABOK_NPM_REGISTRY environment variable to set the npm registry.
149
+
150
+ ALIASES
151
+ $ chabok plugins add
113
152
 
114
153
  EXAMPLES
115
- $ chabok autocomplete
154
+ Install a plugin from npm registry.
116
155
 
117
- $ chabok autocomplete bash
156
+ $ chabok plugins add myplugin
118
157
 
119
- $ chabok autocomplete zsh
158
+ Install a plugin from a github url.
120
159
 
121
- $ chabok autocomplete powershell
160
+ $ chabok plugins add https://github.com/someuser/someplugin
122
161
 
123
- $ chabok autocomplete --refresh-cache
124
- ```
162
+ Install a plugin from a github slug.
125
163
 
126
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.18/src/commands/autocomplete/index.ts)_
164
+ $ chabok plugins add someuser/someplugin
165
+ ```
127
166
 
128
- ## `chabok deploy`
167
+ ## `chabok plugins:inspect PLUGIN...`
129
168
 
130
- this command help you build and deploy your service to chabokan in easy way.
169
+ Displays installation properties of a plugin.
131
170
 
132
171
  ```
133
172
  USAGE
134
- $ chabok deploy [-h] [-p <value>] [-s <value>]
173
+ $ chabok plugins inspect PLUGIN...
174
+
175
+ ARGUMENTS
176
+ PLUGIN... [default: .] Plugin to inspect.
135
177
 
136
178
  FLAGS
137
- -h, --help Show CLI help.
138
- -p, --path=<value> service path in your computer
139
- -s, --service=<value> service name
179
+ -h, --help Show CLI help.
180
+ -v, --verbose
181
+
182
+ GLOBAL FLAGS
183
+ --json Format output as json.
140
184
 
141
185
  DESCRIPTION
142
- this command help you build and deploy your service to chabokan in easy way.
186
+ Displays installation properties of a plugin.
187
+
188
+ EXAMPLES
189
+ $ chabok plugins inspect myplugin
143
190
  ```
144
191
 
145
- _See code: [src/commands/deploy.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/deploy.ts)_
192
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/inspect.ts)_
146
193
 
147
- ## `chabok help [COMMAND]`
194
+ ## `chabok plugins install PLUGIN`
148
195
 
149
- Display help for chabok.
196
+ Installs a plugin into chabok.
150
197
 
151
198
  ```
152
199
  USAGE
153
- $ chabok help [COMMAND...] [-n]
200
+ $ chabok plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
154
201
 
155
202
  ARGUMENTS
156
- COMMAND... Command to show help for.
203
+ PLUGIN... Plugin to install.
157
204
 
158
205
  FLAGS
159
- -n, --nested-commands Include all nested commands in the output.
206
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
207
+ -h, --help Show CLI help.
208
+ -s, --silent Silences npm output.
209
+ -v, --verbose Show verbose npm output.
210
+
211
+ GLOBAL FLAGS
212
+ --json Format output as json.
160
213
 
161
214
  DESCRIPTION
162
- Display help for chabok.
163
- ```
215
+ Installs a plugin into chabok.
164
216
 
165
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
217
+ Uses bundled npm executable to install plugins into /Users/mohammad/.local/share/@chabokan.net/cli
166
218
 
167
- ## `chabok login`
219
+ Installation of a user-installed plugin will override a core plugin.
168
220
 
169
- login to hub.chabokan.net account
221
+ Use the CHABOK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
222
+ Use the CHABOK_NPM_REGISTRY environment variable to set the npm registry.
170
223
 
171
- ```
172
- USAGE
173
- $ chabok login [-h] [-u <value>] [-p <value>] [-t <value>]
224
+ ALIASES
225
+ $ chabok plugins add
174
226
 
175
- FLAGS
176
- -h, --help Show CLI help.
177
- -p, --password=<value> your password
178
- -t, --token=<value> login with api token
179
- -u, --username=<value> your username
227
+ EXAMPLES
228
+ Install a plugin from npm registry.
180
229
 
181
- DESCRIPTION
182
- login to hub.chabokan.net account
230
+ $ chabok plugins install myplugin
231
+
232
+ Install a plugin from a github url.
233
+
234
+ $ chabok plugins install https://github.com/someuser/someplugin
235
+
236
+ Install a plugin from a github slug.
237
+
238
+ $ chabok plugins install someuser/someplugin
183
239
  ```
184
240
 
185
- _See code: [src/commands/login.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/login.ts)_
241
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/install.ts)_
186
242
 
187
- ## `chabok service list`
243
+ ## `chabok plugins link PATH`
188
244
 
189
- show account services list
245
+ Links a plugin into the CLI for development.
190
246
 
191
247
  ```
192
248
  USAGE
193
- $ chabok service list [-h]
249
+ $ chabok plugins link PATH [-h] [--install] [-v]
250
+
251
+ ARGUMENTS
252
+ PATH [default: .] path to plugin
194
253
 
195
254
  FLAGS
196
- -h, --help Show CLI help.
255
+ -h, --help Show CLI help.
256
+ -v, --verbose
257
+ --[no-]install Install dependencies after linking the plugin.
197
258
 
198
259
  DESCRIPTION
199
- show account services list
260
+ Links a plugin into the CLI for development.
261
+ Installation of a linked plugin will override a user-installed or core plugin.
262
+
263
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
264
+ command will override the user-installed or core plugin implementation. This is useful for development work.
265
+
266
+
267
+ EXAMPLES
268
+ $ chabok plugins link myplugin
200
269
  ```
201
270
 
202
- _See code: [src/commands/service/list.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/list.ts)_
271
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/link.ts)_
203
272
 
204
- ## `chabok service logs`
273
+ ## `chabok plugins remove [PLUGIN]`
205
274
 
206
- read latest logs from service
275
+ Removes a plugin from the CLI.
207
276
 
208
277
  ```
209
278
  USAGE
210
- $ chabok service logs [-h] [-s <value>]
279
+ $ chabok plugins remove [PLUGIN...] [-h] [-v]
280
+
281
+ ARGUMENTS
282
+ PLUGIN... plugin to uninstall
211
283
 
212
284
  FLAGS
213
- -h, --help Show CLI help.
214
- -s, --service=<value> service name
285
+ -h, --help Show CLI help.
286
+ -v, --verbose
215
287
 
216
288
  DESCRIPTION
217
- read latest logs from service
218
- ```
289
+ Removes a plugin from the CLI.
219
290
 
220
- _See code: [src/commands/service/logs.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/logs.ts)_
291
+ ALIASES
292
+ $ chabok plugins unlink
293
+ $ chabok plugins remove
294
+
295
+ EXAMPLES
296
+ $ chabok plugins remove myplugin
297
+ ```
221
298
 
222
- ## `chabok service resize`
299
+ ## `chabok plugins reset`
223
300
 
224
- resize a service
301
+ Remove all user-installed and linked plugins.
225
302
 
226
303
  ```
227
304
  USAGE
228
- $ chabok service resize [-h] [-s <value>] [-r <value>] [-c <value>] [-d <value>]
305
+ $ chabok plugins reset [--hard] [--reinstall]
229
306
 
230
307
  FLAGS
231
- -c, --cpu=<value> CPU
232
- -d, --disk=<value> DISK
233
- -h, --help Show CLI help.
234
- -r, --ram=<value> RAM
235
- -s, --service=<value> service name
236
-
237
- DESCRIPTION
238
- resize a service
308
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
309
+ --reinstall Reinstall all plugins after uninstalling.
239
310
  ```
240
311
 
241
- _See code: [src/commands/service/resize.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/resize.ts)_
312
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/reset.ts)_
242
313
 
243
- ## `chabok service restart`
314
+ ## `chabok plugins uninstall [PLUGIN]`
244
315
 
245
- restart a service
316
+ Removes a plugin from the CLI.
246
317
 
247
318
  ```
248
319
  USAGE
249
- $ chabok service restart [-h] [-s <value>]
320
+ $ chabok plugins uninstall [PLUGIN...] [-h] [-v]
321
+
322
+ ARGUMENTS
323
+ PLUGIN... plugin to uninstall
250
324
 
251
325
  FLAGS
252
- -h, --help Show CLI help.
253
- -s, --service=<value> service name
326
+ -h, --help Show CLI help.
327
+ -v, --verbose
254
328
 
255
329
  DESCRIPTION
256
- restart a service
330
+ Removes a plugin from the CLI.
331
+
332
+ ALIASES
333
+ $ chabok plugins unlink
334
+ $ chabok plugins remove
335
+
336
+ EXAMPLES
337
+ $ chabok plugins uninstall myplugin
257
338
  ```
258
339
 
259
- _See code: [src/commands/service/restart.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/restart.ts)_
340
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/uninstall.ts)_
260
341
 
261
- ## `chabok service start`
342
+ ## `chabok plugins unlink [PLUGIN]`
262
343
 
263
- start a service
344
+ Removes a plugin from the CLI.
264
345
 
265
346
  ```
266
347
  USAGE
267
- $ chabok service start [-h] [-s <value>]
348
+ $ chabok plugins unlink [PLUGIN...] [-h] [-v]
349
+
350
+ ARGUMENTS
351
+ PLUGIN... plugin to uninstall
268
352
 
269
353
  FLAGS
270
- -h, --help Show CLI help.
271
- -s, --service=<value> service name
354
+ -h, --help Show CLI help.
355
+ -v, --verbose
272
356
 
273
357
  DESCRIPTION
274
- start a service
275
- ```
358
+ Removes a plugin from the CLI.
276
359
 
277
- _See code: [src/commands/service/start.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/start.ts)_
360
+ ALIASES
361
+ $ chabok plugins unlink
362
+ $ chabok plugins remove
363
+
364
+ EXAMPLES
365
+ $ chabok plugins unlink myplugin
366
+ ```
278
367
 
279
- ## `chabok service stop`
368
+ ## `chabok plugins update`
280
369
 
281
- stop a service
370
+ Update installed plugins.
282
371
 
283
372
  ```
284
373
  USAGE
285
- $ chabok service stop [-h] [-s <value>]
374
+ $ chabok plugins update [-h] [-v]
286
375
 
287
376
  FLAGS
288
- -h, --help Show CLI help.
289
- -s, --service=<value> service name
377
+ -h, --help Show CLI help.
378
+ -v, --verbose
290
379
 
291
380
  DESCRIPTION
292
- stop a service
381
+ Update installed plugins.
293
382
  ```
294
383
 
295
- _See code: [src/commands/service/stop.ts](https://github.com/chabokan/cli/blob/v0.8.7/src/commands/service/stop.ts)_
384
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/update.ts)_
296
385
 
297
386
  ## `chabok version`
298
387
 
package/bin/dev.cmd CHANGED
@@ -1,3 +1,3 @@
1
1
  @echo off
2
2
 
3
- node "%~dp0\dev" %*
3
+ node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
package/bin/dev.js ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
2
+
3
+ // eslint-disable-next-line n/shebang
4
+ import {execute} from '@oclif/core'
5
+
6
+ await execute({development: true, dir: import.meta.url})
package/bin/run.js ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env node
2
+
3
+ import {execute} from '@oclif/core'
4
+
5
+ await execute({dir: import.meta.url})