@choiceopen/automation-plugin-cli 0.0.1 → 0.1.3

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
@@ -20,7 +20,7 @@ $ npm install -g @choiceopen/automation-plugin-cli
20
20
  $ automation COMMAND
21
21
  running command...
22
22
  $ automation (--version)
23
- @choiceopen/automation-plugin-cli/0.0.1 darwin-arm64 node-v24.12.0
23
+ @choiceopen/automation-plugin-cli/0.1.3 darwin-arm64 node-v24.13.0
24
24
  $ automation --help [COMMAND]
25
25
  USAGE
26
26
  $ automation COMMAND
@@ -29,40 +29,10 @@ USAGE
29
29
  <!-- usagestop -->
30
30
  # Commands
31
31
  <!-- commands -->
32
- * [`automation auth login`](#automation-auth-login)
33
32
  * [`automation autocomplete [SHELL]`](#automation-autocomplete-shell)
34
33
  * [`automation help [COMMAND]`](#automation-help-command)
35
- * [`automation plugin checksum [FILE]`](#automation-plugin-checksum-file)
36
- * [`automation plugin init`](#automation-plugin-init)
37
- * [`automation plugin pack [FILE]`](#automation-plugin-pack-file)
38
- * [`automation plugin permission [FILE]`](#automation-plugin-permission-file)
39
- * [`automation plugin run [FILE]`](#automation-plugin-run-file)
40
34
  * [`automation version`](#automation-version)
41
35
 
42
- ## `automation auth login`
43
-
44
- Uses device authorization flow to login with your Choiceform account by following these steps:
45
-
46
- ```
47
- USAGE
48
- $ automation auth login
49
-
50
- DESCRIPTION
51
- Uses device authorization flow to login with your Choiceform account by following these steps:
52
-
53
- 1. Request a validation code automatically
54
- 2. Show the validation code and a verification URL to the user
55
- 3. Open the verification URL in the user's browser and paste the verification code
56
- 4. Submit the validation code to complete the device authorization flow
57
-
58
- EXAMPLES
59
- Login by using device authorization flow
60
-
61
- $ automation auth login
62
- ```
63
-
64
- _See code: [src/commands/auth/login.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/auth/login.ts)_
65
-
66
36
  ## `automation autocomplete [SHELL]`
67
37
 
68
38
  Display autocomplete installation instructions.
@@ -114,144 +84,6 @@ DESCRIPTION
114
84
 
115
85
  _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
116
86
 
117
- ## `automation plugin checksum [FILE]`
118
-
119
- describe the command here
120
-
121
- ```
122
- USAGE
123
- $ automation plugin checksum [FILE] [-f] [-n <value>]
124
-
125
- ARGUMENTS
126
- [FILE] file to read
127
-
128
- FLAGS
129
- -f, --force
130
- -n, --name=<value> name to print
131
-
132
- DESCRIPTION
133
- describe the command here
134
-
135
- EXAMPLES
136
- $ automation plugin checksum
137
- ```
138
-
139
- _See code: [src/commands/plugin/checksum.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/checksum.ts)_
140
-
141
- ## `automation plugin init`
142
-
143
- Initialize a new plugin with step-by-step interactive instructions.
144
-
145
- ```
146
- USAGE
147
- $ automation plugin init [-i] [-n my-awesome-plugin] [-d Descriptive
148
- text...] [-a John Doe] [-e john.doe@example.com] [-u <value>] [--locales en_US|zh_Hans|ja_JP...] [-l
149
- elixir|python|typescript] [-t extension|llm|tool|trigger] [-p endpoints:register|model:call_llm|model:call_embedding
150
- |model:call_moderation|model:call_rerank|model:call_stt|model:call_tts|storage:kv|tools:invoke...]
151
-
152
- FLAGS
153
- -a, --author=John Doe Author name
154
- -d, --description=Descriptive text... Short description
155
- -e, --email=john.doe@example.com Author email address
156
- -i, --[no-]interactive Use interactive mode (by default)
157
- -l, --language=<option> Programming language to use for plugin development
158
- <options: elixir|python|typescript>
159
- -n, --name=my-awesome-plugin Plugin name
160
- -p, --permissions=<option>... Permissions required by the plugin
161
- <options:
162
- endpoints:register|model:call_llm|model:call_embedding|model:call_moderation|mo
163
- del:call_rerank|model:call_stt|model:call_tts|storage:kv|tools:invoke>
164
- -t, --type=<option> Plugin type
165
- <options: extension|llm|tool|trigger>
166
- -u, --url=<value> Repository URL
167
- --locales=<option>... Provide READMEs in which languages
168
- <options: en_US|zh_Hans|ja_JP>
169
-
170
- DESCRIPTION
171
- Initialize a new plugin with step-by-step interactive instructions.
172
-
173
- Providing required flags skips interactive flow and completes initialization in one go.
174
-
175
- EXAMPLES
176
- Start with interactive initialization:
177
-
178
- $ automation plugin init
179
- ```
180
-
181
- _See code: [src/commands/plugin/init.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/init.ts)_
182
-
183
- ## `automation plugin pack [FILE]`
184
-
185
- describe the command here
186
-
187
- ```
188
- USAGE
189
- $ automation plugin pack [FILE] [-f] [-n <value>]
190
-
191
- ARGUMENTS
192
- [FILE] file to read
193
-
194
- FLAGS
195
- -f, --force
196
- -n, --name=<value> name to print
197
-
198
- DESCRIPTION
199
- describe the command here
200
-
201
- EXAMPLES
202
- $ automation plugin pack
203
- ```
204
-
205
- _See code: [src/commands/plugin/pack.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/pack.ts)_
206
-
207
- ## `automation plugin permission [FILE]`
208
-
209
- describe the command here
210
-
211
- ```
212
- USAGE
213
- $ automation plugin permission [FILE] [-f] [-n <value>]
214
-
215
- ARGUMENTS
216
- [FILE] file to read
217
-
218
- FLAGS
219
- -f, --force
220
- -n, --name=<value> name to print
221
-
222
- DESCRIPTION
223
- describe the command here
224
-
225
- EXAMPLES
226
- $ automation plugin permission
227
- ```
228
-
229
- _See code: [src/commands/plugin/permission.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/permission.ts)_
230
-
231
- ## `automation plugin run [FILE]`
232
-
233
- describe the command here
234
-
235
- ```
236
- USAGE
237
- $ automation plugin run [FILE] [-f] [-n <value>]
238
-
239
- ARGUMENTS
240
- [FILE] file to read
241
-
242
- FLAGS
243
- -f, --force
244
- -n, --name=<value> name to print
245
-
246
- DESCRIPTION
247
- describe the command here
248
-
249
- EXAMPLES
250
- $ automation plugin run
251
- ```
252
-
253
- _See code: [src/commands/plugin/run.ts](https://github.com/choice-open/automation-plugin-cli/blob/v0.0.1/src/commands/plugin/run.ts)_
254
-
255
87
  ## `automation version`
256
88
 
257
89
  ```
@@ -1,423 +1,4 @@
1
1
  {
2
- "commands": {
3
- "auth": {
4
- "aliases": [],
5
- "args": {},
6
- "description": "Manages your plugin via subcommands",
7
- "examples": [
8
- {
9
- "command": "<%= config.bin %> help <%= command.id %> [COMMAND]",
10
- "description": "Check help for each individual sub-command"
11
- }
12
- ],
13
- "flags": {
14
- "json": {
15
- "description": "Format output as json.",
16
- "helpGroup": "GLOBAL",
17
- "name": "json",
18
- "allowNo": false,
19
- "type": "boolean"
20
- }
21
- },
22
- "hasDynamicHelp": false,
23
- "hidden": true,
24
- "hiddenAliases": [],
25
- "id": "auth",
26
- "pluginAlias": "@choiceopen/automation-plugin-cli",
27
- "pluginName": "@choiceopen/automation-plugin-cli",
28
- "pluginType": "core",
29
- "strict": true,
30
- "enableJsonFlag": true,
31
- "isESM": true,
32
- "relativePath": [
33
- "dist",
34
- "commands",
35
- "auth",
36
- "index.js"
37
- ]
38
- },
39
- "auth:login": {
40
- "aliases": [],
41
- "args": {},
42
- "description": "Uses device authorization flow to login with your Choiceform account by following these steps:\n\n1. Request a validation code automatically\n2. Show the validation code and a verification URL to the user\n3. Open the verification URL in the user's browser and paste the verification code\n4. Submit the validation code to complete the device authorization flow",
43
- "examples": [
44
- {
45
- "command": "<%= config.bin %> <%= command.id %>",
46
- "description": "Login by using device authorization flow"
47
- }
48
- ],
49
- "flags": {},
50
- "hasDynamicHelp": false,
51
- "hiddenAliases": [],
52
- "id": "auth:login",
53
- "pluginAlias": "@choiceopen/automation-plugin-cli",
54
- "pluginName": "@choiceopen/automation-plugin-cli",
55
- "pluginType": "core",
56
- "strict": true,
57
- "enableJsonFlag": false,
58
- "isESM": true,
59
- "relativePath": [
60
- "dist",
61
- "commands",
62
- "auth",
63
- "login.js"
64
- ]
65
- },
66
- "plugin:checksum": {
67
- "aliases": [],
68
- "args": {
69
- "file": {
70
- "description": "file to read",
71
- "name": "file"
72
- }
73
- },
74
- "description": "describe the command here",
75
- "examples": [
76
- "<%= config.bin %> <%= command.id %>"
77
- ],
78
- "flags": {
79
- "force": {
80
- "char": "f",
81
- "name": "force",
82
- "allowNo": false,
83
- "type": "boolean"
84
- },
85
- "name": {
86
- "char": "n",
87
- "description": "name to print",
88
- "name": "name",
89
- "hasDynamicHelp": false,
90
- "multiple": false,
91
- "type": "option"
92
- }
93
- },
94
- "hasDynamicHelp": false,
95
- "hiddenAliases": [],
96
- "id": "plugin:checksum",
97
- "pluginAlias": "@choiceopen/automation-plugin-cli",
98
- "pluginName": "@choiceopen/automation-plugin-cli",
99
- "pluginType": "core",
100
- "strict": true,
101
- "enableJsonFlag": false,
102
- "isESM": true,
103
- "relativePath": [
104
- "dist",
105
- "commands",
106
- "plugin",
107
- "checksum.js"
108
- ]
109
- },
110
- "plugin": {
111
- "aliases": [],
112
- "args": {},
113
- "description": "Manages your plugin via subcommands",
114
- "examples": [
115
- {
116
- "command": "<%= config.bin %> help <%= command.id %> [COMMAND]",
117
- "description": "Check help for each individual sub-command"
118
- }
119
- ],
120
- "flags": {
121
- "json": {
122
- "description": "Format output as json.",
123
- "helpGroup": "GLOBAL",
124
- "name": "json",
125
- "allowNo": false,
126
- "type": "boolean"
127
- }
128
- },
129
- "hasDynamicHelp": false,
130
- "hidden": true,
131
- "hiddenAliases": [],
132
- "id": "plugin",
133
- "pluginAlias": "@choiceopen/automation-plugin-cli",
134
- "pluginName": "@choiceopen/automation-plugin-cli",
135
- "pluginType": "core",
136
- "strict": true,
137
- "enableJsonFlag": true,
138
- "isESM": true,
139
- "relativePath": [
140
- "dist",
141
- "commands",
142
- "plugin",
143
- "index.js"
144
- ]
145
- },
146
- "plugin:init": {
147
- "aliases": [],
148
- "args": {},
149
- "description": "Initialize a new plugin with step-by-step interactive instructions.\n\nProviding required flags skips interactive flow and completes initialization in one go.",
150
- "examples": [
151
- {
152
- "command": "<%= config.bin %> <%= command.id %>",
153
- "description": "Start with interactive initialization:"
154
- }
155
- ],
156
- "flags": {
157
- "interactive": {
158
- "char": "i",
159
- "name": "interactive",
160
- "summary": "Use interactive mode (by default)",
161
- "allowNo": true,
162
- "type": "boolean"
163
- },
164
- "name": {
165
- "char": "n",
166
- "name": "name",
167
- "summary": "Plugin name",
168
- "hasDynamicHelp": false,
169
- "helpValue": "my-awesome-plugin",
170
- "multiple": false,
171
- "type": "option"
172
- },
173
- "description": {
174
- "char": "d",
175
- "name": "description",
176
- "summary": "Short description",
177
- "default": "",
178
- "hasDynamicHelp": false,
179
- "helpValue": "Descriptive text...",
180
- "multiple": false,
181
- "type": "option"
182
- },
183
- "author": {
184
- "char": "a",
185
- "name": "author",
186
- "summary": "Author name",
187
- "default": "",
188
- "hasDynamicHelp": false,
189
- "helpValue": "John Doe",
190
- "multiple": false,
191
- "type": "option"
192
- },
193
- "email": {
194
- "char": "e",
195
- "name": "email",
196
- "summary": "Author email address",
197
- "default": "",
198
- "hasDynamicHelp": false,
199
- "helpValue": "john.doe@example.com",
200
- "multiple": false,
201
- "type": "option"
202
- },
203
- "url": {
204
- "char": "u",
205
- "name": "url",
206
- "summary": "Repository URL",
207
- "default": "",
208
- "hasDynamicHelp": false,
209
- "multiple": false,
210
- "type": "option"
211
- },
212
- "locales": {
213
- "name": "locales",
214
- "summary": "Provide READMEs in which languages",
215
- "delimiter": ",",
216
- "hasDynamicHelp": false,
217
- "multiple": true,
218
- "options": [
219
- "en_US",
220
- "zh_Hans",
221
- "ja_JP"
222
- ],
223
- "type": "option"
224
- },
225
- "language": {
226
- "char": "l",
227
- "name": "language",
228
- "summary": "Programming language to use for plugin development",
229
- "hasDynamicHelp": false,
230
- "multiple": false,
231
- "options": [
232
- "elixir",
233
- "python",
234
- "typescript"
235
- ],
236
- "type": "option"
237
- },
238
- "type": {
239
- "char": "t",
240
- "name": "type",
241
- "summary": "Plugin type",
242
- "hasDynamicHelp": false,
243
- "multiple": false,
244
- "options": [
245
- "extension",
246
- "llm",
247
- "tool",
248
- "trigger"
249
- ],
250
- "type": "option"
251
- },
252
- "permissions": {
253
- "char": "p",
254
- "name": "permissions",
255
- "summary": "Permissions required by the plugin",
256
- "delimiter": ",",
257
- "hasDynamicHelp": false,
258
- "multiple": true,
259
- "options": [
260
- "endpoints:register",
261
- "model:call_llm",
262
- "model:call_embedding",
263
- "model:call_moderation",
264
- "model:call_rerank",
265
- "model:call_stt",
266
- "model:call_tts",
267
- "storage:kv",
268
- "tools:invoke"
269
- ],
270
- "type": "option"
271
- }
272
- },
273
- "hasDynamicHelp": false,
274
- "hiddenAliases": [],
275
- "id": "plugin:init",
276
- "pluginAlias": "@choiceopen/automation-plugin-cli",
277
- "pluginName": "@choiceopen/automation-plugin-cli",
278
- "pluginType": "core",
279
- "strict": true,
280
- "enableJsonFlag": false,
281
- "isESM": true,
282
- "relativePath": [
283
- "dist",
284
- "commands",
285
- "plugin",
286
- "init.js"
287
- ]
288
- },
289
- "plugin:pack": {
290
- "aliases": [],
291
- "args": {
292
- "file": {
293
- "description": "file to read",
294
- "name": "file"
295
- }
296
- },
297
- "description": "describe the command here",
298
- "examples": [
299
- "<%= config.bin %> <%= command.id %>"
300
- ],
301
- "flags": {
302
- "force": {
303
- "char": "f",
304
- "name": "force",
305
- "allowNo": false,
306
- "type": "boolean"
307
- },
308
- "name": {
309
- "char": "n",
310
- "description": "name to print",
311
- "name": "name",
312
- "hasDynamicHelp": false,
313
- "multiple": false,
314
- "type": "option"
315
- }
316
- },
317
- "hasDynamicHelp": false,
318
- "hiddenAliases": [],
319
- "id": "plugin:pack",
320
- "pluginAlias": "@choiceopen/automation-plugin-cli",
321
- "pluginName": "@choiceopen/automation-plugin-cli",
322
- "pluginType": "core",
323
- "strict": true,
324
- "enableJsonFlag": false,
325
- "isESM": true,
326
- "relativePath": [
327
- "dist",
328
- "commands",
329
- "plugin",
330
- "pack.js"
331
- ]
332
- },
333
- "plugin:permission": {
334
- "aliases": [],
335
- "args": {
336
- "file": {
337
- "description": "file to read",
338
- "name": "file"
339
- }
340
- },
341
- "description": "describe the command here",
342
- "examples": [
343
- "<%= config.bin %> <%= command.id %>"
344
- ],
345
- "flags": {
346
- "force": {
347
- "char": "f",
348
- "name": "force",
349
- "allowNo": false,
350
- "type": "boolean"
351
- },
352
- "name": {
353
- "char": "n",
354
- "description": "name to print",
355
- "name": "name",
356
- "hasDynamicHelp": false,
357
- "multiple": false,
358
- "type": "option"
359
- }
360
- },
361
- "hasDynamicHelp": false,
362
- "hiddenAliases": [],
363
- "id": "plugin:permission",
364
- "pluginAlias": "@choiceopen/automation-plugin-cli",
365
- "pluginName": "@choiceopen/automation-plugin-cli",
366
- "pluginType": "core",
367
- "strict": true,
368
- "enableJsonFlag": false,
369
- "isESM": true,
370
- "relativePath": [
371
- "dist",
372
- "commands",
373
- "plugin",
374
- "permission.js"
375
- ]
376
- },
377
- "plugin:run": {
378
- "aliases": [],
379
- "args": {
380
- "file": {
381
- "description": "file to read",
382
- "name": "file"
383
- }
384
- },
385
- "description": "describe the command here",
386
- "examples": [
387
- "<%= config.bin %> <%= command.id %>"
388
- ],
389
- "flags": {
390
- "force": {
391
- "char": "f",
392
- "name": "force",
393
- "allowNo": false,
394
- "type": "boolean"
395
- },
396
- "name": {
397
- "char": "n",
398
- "description": "name to print",
399
- "name": "name",
400
- "hasDynamicHelp": false,
401
- "multiple": false,
402
- "type": "option"
403
- }
404
- },
405
- "hasDynamicHelp": false,
406
- "hiddenAliases": [],
407
- "id": "plugin:run",
408
- "pluginAlias": "@choiceopen/automation-plugin-cli",
409
- "pluginName": "@choiceopen/automation-plugin-cli",
410
- "pluginType": "core",
411
- "strict": true,
412
- "enableJsonFlag": false,
413
- "isESM": true,
414
- "relativePath": [
415
- "dist",
416
- "commands",
417
- "plugin",
418
- "run.js"
419
- ]
420
- }
421
- },
422
- "version": "0.0.1"
2
+ "commands": {},
3
+ "version": "0.1.3"
423
4
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@choiceopen/automation-plugin-cli",
3
- "version": "0.0.1",
3
+ "version": "0.1.3",
4
4
  "description": "A command-line utility for building and publishing Choiceform Automation Plugin.",
5
5
  "keywords": [
6
6
  "oclif"
@@ -1,11 +0,0 @@
1
- import { Command } from "@oclif/core";
2
- export default class Auth extends Command {
3
- static description: string;
4
- static enableJsonFlag: boolean;
5
- static examples: {
6
- command: string;
7
- description: string;
8
- }[];
9
- static hidden: boolean;
10
- run(): Promise<void>;
11
- }
@@ -1,15 +0,0 @@
1
- import { Command } from "@oclif/core";
2
- export default class Auth extends Command {
3
- static description = "Manages your plugin via subcommands";
4
- static enableJsonFlag = true;
5
- static examples = [
6
- {
7
- command: "<%= config.bin %> help <%= command.id %> [COMMAND]",
8
- description: "Check help for each individual sub-command",
9
- },
10
- ];
11
- static hidden = true;
12
- async run() {
13
- await this.config.runCommand("help", ["auth"]);
14
- }
15
- }
@@ -1,15 +0,0 @@
1
- import { Command } from "@oclif/core";
2
- export default class AuthLogin extends Command {
3
- static description: string;
4
- static examples: {
5
- command: string;
6
- description: string;
7
- }[];
8
- static flags: {};
9
- private pollingInterval;
10
- private client_id;
11
- private grant_type;
12
- run(): Promise<void>;
13
- private requestDeviceCode;
14
- private pollForToken;
15
- }