Skip to content

Commit 5d21221

Browse files
committed
chore: update README.md
1 parent 6cce97c commit 5d21221

1 file changed

Lines changed: 197 additions & 0 deletions

File tree

README.md

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,64 @@ USAGE
6464
## Commands
6565

6666
<!-- commands -->
67+
* [`atomemo auth login`](#atomemo-auth-login)
68+
* [`atomemo auth status`](#atomemo-auth-status)
6769
* [`atomemo autocomplete [SHELL]`](#atomemo-autocomplete-shell)
6870
* [`atomemo help [COMMAND]`](#atomemo-help-command)
71+
* [`atomemo plugin checksum [FILE]`](#atomemo-plugin-checksum-file)
72+
* [`atomemo plugin init`](#atomemo-plugin-init)
73+
* [`atomemo plugin pack [FILE]`](#atomemo-plugin-pack-file)
74+
* [`atomemo plugin permission [FILE]`](#atomemo-plugin-permission-file)
75+
* [`atomemo plugin refresh-key`](#atomemo-plugin-refresh-key)
76+
* [`atomemo plugin run [FILE]`](#atomemo-plugin-run-file)
6977
* [`atomemo version`](#atomemo-version)
7078

79+
## `atomemo auth login`
80+
81+
Uses device authorization flow to login with your Choiceform account by following these steps:
82+
83+
```
84+
USAGE
85+
$ atomemo auth login
86+
87+
DESCRIPTION
88+
Uses device authorization flow to login with your Choiceform account by following these steps:
89+
90+
1. Request a validation code automatically
91+
2. Show the validation code and a verification URL to the user
92+
3. Open the verification URL in the user's browser and paste the verification code
93+
4. Submit the validation code to complete the device authorization flow
94+
95+
EXAMPLES
96+
Login by using device authorization flow
97+
98+
$ atomemo auth login
99+
```
100+
101+
_See code: [src/commands/auth/login.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/auth/login.ts)_
102+
103+
## `atomemo auth status`
104+
105+
Display the current authentication status.
106+
107+
```
108+
USAGE
109+
$ atomemo auth status
110+
111+
DESCRIPTION
112+
Display the current authentication status.
113+
114+
Shows user information and session details if authenticated,
115+
or prompts to login if not yet authenticated.
116+
117+
EXAMPLES
118+
Check current authentication status
119+
120+
$ atomemo auth status
121+
```
122+
123+
_See code: [src/commands/auth/status.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/auth/status.ts)_
124+
71125
## `atomemo autocomplete [SHELL]`
72126

73127
Display autocomplete installation instructions.
@@ -119,6 +173,149 @@ DESCRIPTION
119173

120174
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
121175

176+
## `atomemo plugin checksum [FILE]`
177+
178+
describe the command here
179+
180+
```
181+
USAGE
182+
$ atomemo plugin checksum [FILE] [-f] [-n <value>]
183+
184+
ARGUMENTS
185+
[FILE] file to read
186+
187+
FLAGS
188+
-f, --force
189+
-n, --name=<value> name to print
190+
191+
DESCRIPTION
192+
describe the command here
193+
194+
EXAMPLES
195+
$ atomemo plugin checksum
196+
```
197+
198+
_See code: [src/commands/plugin/checksum.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/checksum.ts)_
199+
200+
## `atomemo plugin init`
201+
202+
Initialize a new plugin with step-by-step interactive instructions.
203+
204+
```
205+
USAGE
206+
$ atomemo plugin init [-i] [-n my-awesome-plugin] [-d Descriptive text...]
207+
[-u <value>] [-l elixir|python|typescript]
208+
209+
FLAGS
210+
-d, --description=Descriptive text... Short description
211+
-i, --[no-]interactive Use interactive mode (by default)
212+
-l, --language=<option> Programming language to use for plugin development
213+
<options: elixir|python|typescript>
214+
-n, --name=my-awesome-plugin Plugin name
215+
-u, --url=<value> Repository URL
216+
217+
DESCRIPTION
218+
Initialize a new plugin with step-by-step interactive instructions.
219+
220+
Providing required flags skips interactive flow and completes initialization in one go.
221+
222+
EXAMPLES
223+
Start with interactive initialization:
224+
225+
$ atomemo plugin init
226+
```
227+
228+
_See code: [src/commands/plugin/init.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/init.ts)_
229+
230+
## `atomemo plugin pack [FILE]`
231+
232+
describe the command here
233+
234+
```
235+
USAGE
236+
$ atomemo plugin pack [FILE] [-f] [-n <value>]
237+
238+
ARGUMENTS
239+
[FILE] file to read
240+
241+
FLAGS
242+
-f, --force
243+
-n, --name=<value> name to print
244+
245+
DESCRIPTION
246+
describe the command here
247+
248+
EXAMPLES
249+
$ atomemo plugin pack
250+
```
251+
252+
_See code: [src/commands/plugin/pack.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/pack.ts)_
253+
254+
## `atomemo plugin permission [FILE]`
255+
256+
describe the command here
257+
258+
```
259+
USAGE
260+
$ atomemo plugin permission [FILE] [-f] [-n <value>]
261+
262+
ARGUMENTS
263+
[FILE] file to read
264+
265+
FLAGS
266+
-f, --force
267+
-n, --name=<value> name to print
268+
269+
DESCRIPTION
270+
describe the command here
271+
272+
EXAMPLES
273+
$ atomemo plugin permission
274+
```
275+
276+
_See code: [src/commands/plugin/permission.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/permission.ts)_
277+
278+
## `atomemo plugin refresh-key`
279+
280+
Refresh or create API Key for plugin debugging in development stage.
281+
282+
```
283+
USAGE
284+
$ atomemo plugin refresh-key
285+
286+
DESCRIPTION
287+
Refresh or create API Key for plugin debugging in development stage.
288+
289+
EXAMPLES
290+
$ atomemo plugin refresh-key
291+
```
292+
293+
_See code: [src/commands/plugin/refresh-key.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/refresh-key.ts)_
294+
295+
## `atomemo plugin run [FILE]`
296+
297+
describe the command here
298+
299+
```
300+
USAGE
301+
$ atomemo plugin run [FILE] [-f] [-n <value>]
302+
303+
ARGUMENTS
304+
[FILE] file to read
305+
306+
FLAGS
307+
-f, --force
308+
-n, --name=<value> name to print
309+
310+
DESCRIPTION
311+
describe the command here
312+
313+
EXAMPLES
314+
$ atomemo plugin run
315+
```
316+
317+
_See code: [src/commands/plugin/run.ts](https://github.com/choice-open/atomemo-plugin-cli/blob/v0.5.6/src/commands/plugin/run.ts)_
318+
122319
## `atomemo version`
123320

124321
```

0 commit comments

Comments
 (0)