@chabokan.net/cli 0.8.6 → 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.6 darwin-arm64 node-v18.12.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,253 +29,360 @@ 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
- * [`chabok help [COMMANDS]`](#chabok-help-commands)
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)
33
+ * [`chabok help [COMMAND]`](#chabok-help-command)
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
- ## `chabok account remove`
75
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.18/src/commands/autocomplete/index.ts)_
76
+
77
+ ## `chabok help [COMMAND]`
61
78
 
62
- remove account from list
79
+ Display help for chabok.
63
80
 
64
81
  ```
65
82
  USAGE
66
- $ chabok account remove [-h]
83
+ $ chabok help [COMMAND...] [-n]
84
+
85
+ ARGUMENTS
86
+ COMMAND... Command to show help for.
67
87
 
68
88
  FLAGS
69
- -h, --help Show CLI help.
89
+ -n, --nested-commands Include all nested commands in the output.
70
90
 
71
91
  DESCRIPTION
72
- remove account from list
92
+ Display help for chabok.
73
93
  ```
74
94
 
75
- ## `chabok account use`
95
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
96
+
97
+ ## `chabok plugins`
76
98
 
77
- switch your default user between logged in users
99
+ List installed plugins.
78
100
 
79
101
  ```
80
102
  USAGE
81
- $ chabok account use [-h] [-u <value>]
103
+ $ chabok plugins [--json] [--core]
82
104
 
83
105
  FLAGS
84
- -h, --help Show CLI help.
85
- -u, --user=<value> default user
106
+ --core Show core plugins.
107
+
108
+ GLOBAL FLAGS
109
+ --json Format output as json.
86
110
 
87
111
  DESCRIPTION
88
- switch your default user between logged in users
112
+ List installed plugins.
113
+
114
+ EXAMPLES
115
+ $ chabok plugins
89
116
  ```
90
117
 
91
- ## `chabok autocomplete [SHELL]`
118
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/index.ts)_
119
+
120
+ ## `chabok plugins add PLUGIN`
92
121
 
93
- display autocomplete installation instructions
122
+ Installs a plugin into chabok.
94
123
 
95
124
  ```
96
125
  USAGE
97
- $ chabok autocomplete [SHELL] [-r]
126
+ $ chabok plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
98
127
 
99
128
  ARGUMENTS
100
- SHELL shell type
129
+ PLUGIN... Plugin to install.
101
130
 
102
131
  FLAGS
103
- -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.
104
139
 
105
140
  DESCRIPTION
106
- 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
107
152
 
108
153
  EXAMPLES
109
- $ chabok autocomplete
154
+ Install a plugin from npm registry.
110
155
 
111
- $ chabok autocomplete bash
156
+ $ chabok plugins add myplugin
112
157
 
113
- $ chabok autocomplete zsh
158
+ Install a plugin from a github url.
114
159
 
115
- $ chabok autocomplete --refresh-cache
116
- ```
160
+ $ chabok plugins add https://github.com/someuser/someplugin
161
+
162
+ Install a plugin from a github slug.
117
163
 
118
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.4.6/src/commands/autocomplete/index.ts)_
164
+ $ chabok plugins add someuser/someplugin
165
+ ```
119
166
 
120
- ## `chabok deploy`
167
+ ## `chabok plugins:inspect PLUGIN...`
121
168
 
122
- this command help you build and deploy your service to chabokan in easy way.
169
+ Displays installation properties of a plugin.
123
170
 
124
171
  ```
125
172
  USAGE
126
- $ chabok deploy [-h] [-p <value>] [-s <value>]
173
+ $ chabok plugins inspect PLUGIN...
174
+
175
+ ARGUMENTS
176
+ PLUGIN... [default: .] Plugin to inspect.
127
177
 
128
178
  FLAGS
129
- -h, --help Show CLI help.
130
- -p, --path=<value> service path in your computer
131
- -s, --service=<value> service name
179
+ -h, --help Show CLI help.
180
+ -v, --verbose
181
+
182
+ GLOBAL FLAGS
183
+ --json Format output as json.
132
184
 
133
185
  DESCRIPTION
134
- 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
135
190
  ```
136
191
 
137
- _See code: [src/commands/deploy.ts](https://github.com/chabokan/cli/blob/v0.8.6/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)_
138
193
 
139
- ## `chabok help [COMMANDS]`
194
+ ## `chabok plugins install PLUGIN`
140
195
 
141
- Display help for chabok.
196
+ Installs a plugin into chabok.
142
197
 
143
198
  ```
144
199
  USAGE
145
- $ chabok help [COMMANDS] [-n]
200
+ $ chabok plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
146
201
 
147
202
  ARGUMENTS
148
- COMMANDS Command to show help for.
203
+ PLUGIN... Plugin to install.
149
204
 
150
205
  FLAGS
151
- -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.
152
213
 
153
214
  DESCRIPTION
154
- Display help for chabok.
155
- ```
215
+ Installs a plugin into chabok.
156
216
 
157
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.10/src/commands/help.ts)_
217
+ Uses bundled npm executable to install plugins into /Users/mohammad/.local/share/@chabokan.net/cli
158
218
 
159
- ## `chabok login`
219
+ Installation of a user-installed plugin will override a core plugin.
160
220
 
161
- 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.
162
223
 
163
- ```
164
- USAGE
165
- $ chabok login [-h] [-u <value>] [-p <value>] [-t <value>]
224
+ ALIASES
225
+ $ chabok plugins add
166
226
 
167
- FLAGS
168
- -h, --help Show CLI help.
169
- -p, --password=<value> your password
170
- -t, --token=<value> login with api token
171
- -u, --username=<value> your username
227
+ EXAMPLES
228
+ Install a plugin from npm registry.
172
229
 
173
- DESCRIPTION
174
- 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
175
239
  ```
176
240
 
177
- _See code: [src/commands/login.ts](https://github.com/chabokan/cli/blob/v0.8.6/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)_
178
242
 
179
- ## `chabok service list`
243
+ ## `chabok plugins link PATH`
180
244
 
181
- show account services list
245
+ Links a plugin into the CLI for development.
182
246
 
183
247
  ```
184
248
  USAGE
185
- $ chabok service list [-h]
249
+ $ chabok plugins link PATH [-h] [--install] [-v]
250
+
251
+ ARGUMENTS
252
+ PATH [default: .] path to plugin
186
253
 
187
254
  FLAGS
188
- -h, --help Show CLI help.
255
+ -h, --help Show CLI help.
256
+ -v, --verbose
257
+ --[no-]install Install dependencies after linking the plugin.
189
258
 
190
259
  DESCRIPTION
191
- 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
192
269
  ```
193
270
 
194
- ## `chabok service logs`
271
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/link.ts)_
195
272
 
196
- read latest logs from service
273
+ ## `chabok plugins remove [PLUGIN]`
274
+
275
+ Removes a plugin from the CLI.
197
276
 
198
277
  ```
199
278
  USAGE
200
- $ chabok service logs [-h] [-s <value>]
279
+ $ chabok plugins remove [PLUGIN...] [-h] [-v]
280
+
281
+ ARGUMENTS
282
+ PLUGIN... plugin to uninstall
201
283
 
202
284
  FLAGS
203
- -h, --help Show CLI help.
204
- -s, --service=<value> service name
285
+ -h, --help Show CLI help.
286
+ -v, --verbose
205
287
 
206
288
  DESCRIPTION
207
- read latest logs from service
289
+ Removes a plugin from the CLI.
290
+
291
+ ALIASES
292
+ $ chabok plugins unlink
293
+ $ chabok plugins remove
294
+
295
+ EXAMPLES
296
+ $ chabok plugins remove myplugin
208
297
  ```
209
298
 
210
- ## `chabok service resize`
299
+ ## `chabok plugins reset`
211
300
 
212
- resize a service
301
+ Remove all user-installed and linked plugins.
213
302
 
214
303
  ```
215
304
  USAGE
216
- $ chabok service resize [-h] [-s <value>] [-r <value>] [-c <value>] [-d <value>]
305
+ $ chabok plugins reset [--hard] [--reinstall]
217
306
 
218
307
  FLAGS
219
- -c, --cpu=<value> CPU
220
- -d, --disk=<value> DISK
221
- -h, --help Show CLI help.
222
- -r, --ram=<value> RAM
223
- -s, --service=<value> service name
224
-
225
- DESCRIPTION
226
- 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.
227
310
  ```
228
311
 
229
- ## `chabok service restart`
312
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/reset.ts)_
313
+
314
+ ## `chabok plugins uninstall [PLUGIN]`
230
315
 
231
- restart a service
316
+ Removes a plugin from the CLI.
232
317
 
233
318
  ```
234
319
  USAGE
235
- $ chabok service restart [-h] [-s <value>]
320
+ $ chabok plugins uninstall [PLUGIN...] [-h] [-v]
321
+
322
+ ARGUMENTS
323
+ PLUGIN... plugin to uninstall
236
324
 
237
325
  FLAGS
238
- -h, --help Show CLI help.
239
- -s, --service=<value> service name
326
+ -h, --help Show CLI help.
327
+ -v, --verbose
240
328
 
241
329
  DESCRIPTION
242
- 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
243
338
  ```
244
339
 
245
- ## `chabok service start`
340
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/uninstall.ts)_
341
+
342
+ ## `chabok plugins unlink [PLUGIN]`
246
343
 
247
- start a service
344
+ Removes a plugin from the CLI.
248
345
 
249
346
  ```
250
347
  USAGE
251
- $ chabok service start [-h] [-s <value>]
348
+ $ chabok plugins unlink [PLUGIN...] [-h] [-v]
349
+
350
+ ARGUMENTS
351
+ PLUGIN... plugin to uninstall
252
352
 
253
353
  FLAGS
254
- -h, --help Show CLI help.
255
- -s, --service=<value> service name
354
+ -h, --help Show CLI help.
355
+ -v, --verbose
256
356
 
257
357
  DESCRIPTION
258
- start a service
358
+ Removes a plugin from the CLI.
359
+
360
+ ALIASES
361
+ $ chabok plugins unlink
362
+ $ chabok plugins remove
363
+
364
+ EXAMPLES
365
+ $ chabok plugins unlink myplugin
259
366
  ```
260
367
 
261
- ## `chabok service stop`
368
+ ## `chabok plugins update`
262
369
 
263
- stop a service
370
+ Update installed plugins.
264
371
 
265
372
  ```
266
373
  USAGE
267
- $ chabok service stop [-h] [-s <value>]
374
+ $ chabok plugins update [-h] [-v]
268
375
 
269
376
  FLAGS
270
- -h, --help Show CLI help.
271
- -s, --service=<value> service name
377
+ -h, --help Show CLI help.
378
+ -v, --verbose
272
379
 
273
380
  DESCRIPTION
274
- stop a service
381
+ Update installed plugins.
275
382
  ```
276
383
 
384
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.3/src/commands/plugins/update.ts)_
385
+
277
386
  ## `chabok version`
278
387
 
279
388
  ```
@@ -292,5 +401,5 @@ FLAG DESCRIPTIONS
292
401
  Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
293
402
  ```
294
403
 
295
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.3.5/src/commands/version.ts)_
404
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.1.2/src/commands/version.ts)_
296
405
  <!-- commandsstop -->
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})