Skip to content

Commit 8bad2de

Browse files
KennethWussmannKennethWussmann
committed
Fix command visibility
1 parent 537c0ef commit 8bad2de

11 files changed

Lines changed: 317 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 306 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,94 @@ $ sl alias ls --format json | jq "map(.email)"
5858

5959
# Commands
6060
<!-- commands -->
61+
* [`sl alias create`](#sl-alias-create)
62+
* [`sl alias create-custom PREFIX SUFFIX`](#sl-alias-create-custom-prefix-suffix)
6163
* [`sl alias custom PREFIX SUFFIX`](#sl-alias-custom-prefix-suffix)
64+
* [`sl alias delete ALIAS-ID`](#sl-alias-delete-alias-id)
65+
* [`sl alias list`](#sl-alias-list)
6266
* [`sl alias ls`](#sl-alias-ls)
6367
* [`sl alias rm ALIAS-ID`](#sl-alias-rm-alias-id)
68+
* [`sl alias search QUERY`](#sl-alias-search-query)
69+
* [`sl config`](#sl-config)
6470
* [`sl help [COMMAND]`](#sl-help-command)
71+
* [`sl login`](#sl-login)
72+
* [`sl logout`](#sl-logout)
73+
* [`sl whoami`](#sl-whoami)
74+
75+
## `sl alias create`
76+
77+
Create a new random alias
78+
79+
```
80+
USAGE
81+
$ sl alias create [--config <value>] [--format plain|json|yaml] [--note <value>] [--hostname <value>] [--mode
82+
uuid|word]
83+
84+
FLAGS
85+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
86+
--format=<option> [default: plain] Output format
87+
<options: plain|json|yaml>
88+
--hostname=<value> Associated hostname
89+
--mode=<option> Generation mode (uuid or word-based)
90+
<options: uuid|word>
91+
--note=<value> Note/description for the alias
92+
93+
DESCRIPTION
94+
Create a new random alias
95+
96+
EXAMPLES
97+
$ sl alias create
98+
99+
$ sl alias create --note "My test alias"
100+
101+
$ sl alias create --hostname example.com
102+
103+
$ sl alias create --mode uuid
104+
105+
$ sl alias create --mode word --note "Shopping" --format json
106+
```
107+
108+
_See code: [src/commands/alias/create.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/alias/create.ts)_
109+
110+
## `sl alias create-custom PREFIX SUFFIX`
111+
112+
Create a custom alias with specific prefix and suffix
113+
114+
```
115+
USAGE
116+
$ sl alias create-custom PREFIX SUFFIX --mailbox-ids <value> [--config <value>] [--format plain|json|yaml] [--note
117+
<value>] [--hostname <value>] [--name <value>]
118+
119+
ARGUMENTS
120+
PREFIX Alias prefix (local part)
121+
SUFFIX Signed suffix from alias options
122+
123+
FLAGS
124+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
125+
--format=<option> [default: plain] Output format
126+
<options: plain|json|yaml>
127+
--hostname=<value> Associated hostname
128+
--mailbox-ids=<value> (required) Comma-separated mailbox IDs
129+
--name=<value> Display name
130+
--note=<value> Note/description for the alias
131+
132+
DESCRIPTION
133+
Create a custom alias with specific prefix and suffix
134+
135+
ALIASES
136+
$ sl alias custom
137+
138+
EXAMPLES
139+
$ sl alias create-custom myprefix signed_suffix --mailbox-ids 1,2
140+
141+
$ sl alias create-custom john suffix123 --mailbox-ids 1 --note "Work email"
142+
143+
$ sl alias create-custom support suffix456 --mailbox-ids 1 --name "Support" --hostname example.com
144+
145+
$ sl alias create-custom custom suffix789 --mailbox-ids 1,2,3 --format json
146+
```
147+
148+
_See code: [src/commands/alias/create-custom.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/alias/create-custom.ts)_
65149

66150
## `sl alias custom PREFIX SUFFIX`
67151

@@ -101,6 +185,84 @@ EXAMPLES
101185
$ sl alias custom custom suffix789 --mailbox-ids 1,2,3 --format json
102186
```
103187

188+
## `sl alias delete ALIAS-ID`
189+
190+
Delete an alias by ID
191+
192+
```
193+
USAGE
194+
$ sl alias delete ALIAS-ID [--config <value>] [--format plain|json|yaml] [--confirm]
195+
196+
ARGUMENTS
197+
ALIAS-ID Alias ID to delete
198+
199+
FLAGS
200+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
201+
--confirm Skip confirmation prompt
202+
--format=<option> [default: plain] Output format
203+
<options: plain|json|yaml>
204+
205+
DESCRIPTION
206+
Delete an alias by ID
207+
208+
ALIASES
209+
$ sl alias rm
210+
211+
EXAMPLES
212+
$ sl alias delete 123
213+
214+
$ sl alias delete 123 --confirm
215+
216+
$ sl alias delete 123 --format json
217+
218+
$ sl alias rm 123 --confirm
219+
```
220+
221+
_See code: [src/commands/alias/delete.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/alias/delete.ts)_
222+
223+
## `sl alias list`
224+
225+
List all aliases with pagination
226+
227+
```
228+
USAGE
229+
$ sl alias list [--config <value>] [--format plain|json|yaml] [--page <value>] [--pinned | --disabled |
230+
--enabled] [--all]
231+
232+
FLAGS
233+
--all Fetch all pages automatically
234+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
235+
--disabled Show only disabled aliases
236+
--enabled Show only enabled aliases
237+
--format=<option> [default: plain] Output format
238+
<options: plain|json|yaml>
239+
--page=<value> Page number (20 aliases per page)
240+
--pinned Show only pinned aliases
241+
242+
DESCRIPTION
243+
List all aliases with pagination
244+
245+
ALIASES
246+
$ sl alias ls
247+
248+
EXAMPLES
249+
$ sl alias list
250+
251+
$ sl alias list --page 1
252+
253+
$ sl alias list --pinned
254+
255+
$ sl alias list --disabled
256+
257+
$ sl alias list --enabled
258+
259+
$ sl alias list --all
260+
261+
$ sl alias list --format json
262+
```
263+
264+
_See code: [src/commands/alias/list.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/alias/list.ts)_
265+
104266
## `sl alias ls`
105267

106268
List all aliases with pagination
@@ -175,6 +337,72 @@ EXAMPLES
175337
$ sl alias rm 123 --confirm
176338
```
177339

340+
## `sl alias search QUERY`
341+
342+
Search aliases by email address
343+
344+
```
345+
USAGE
346+
$ sl alias search QUERY [--config <value>] [--format plain|json|yaml] [--page <value>] [--pinned | --disabled |
347+
--enabled] [--all]
348+
349+
ARGUMENTS
350+
QUERY Search query for alias email
351+
352+
FLAGS
353+
--all Fetch all pages automatically
354+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
355+
--disabled Show only disabled aliases
356+
--enabled Show only enabled aliases
357+
--format=<option> [default: plain] Output format
358+
<options: plain|json|yaml>
359+
--page=<value> Page number (20 aliases per page)
360+
--pinned Show only pinned aliases
361+
362+
DESCRIPTION
363+
Search aliases by email address
364+
365+
EXAMPLES
366+
$ sl alias search myalias
367+
368+
$ sl alias search "john@" --page 1
369+
370+
$ sl alias search example --pinned
371+
372+
$ sl alias search test --all
373+
374+
$ sl alias search search --format json
375+
```
376+
377+
_See code: [src/commands/alias/search.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/alias/search.ts)_
378+
379+
## `sl config`
380+
381+
Display current configuration
382+
383+
```
384+
USAGE
385+
$ sl config [--config <value>] [--format plain|json|yaml] [--show-key]
386+
387+
FLAGS
388+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
389+
--format=<option> [default: plain] Output format
390+
<options: plain|json|yaml>
391+
--show-key Show full API key (default: redacted)
392+
393+
DESCRIPTION
394+
Display current configuration
395+
396+
EXAMPLES
397+
$ sl config
398+
399+
$ sl config --show-key
400+
401+
$ sl config --format json
402+
```
403+
404+
_See code: [src/commands/config.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/config.ts)_
405+
178406
## `sl help [COMMAND]`
179407

180408
Display help for sl.
@@ -194,4 +422,82 @@ DESCRIPTION
194422
```
195423

196424
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
425+
426+
## `sl login`
427+
428+
Authenticate with SimpleLogin and store credentials
429+
430+
```
431+
USAGE
432+
$ sl login [--config <value>] [--format plain|json|yaml] [--device <value>] [--key <value>] [--url
433+
<value>]
434+
435+
FLAGS
436+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
437+
--device=<value> [default: simplelogin-cli] Device name for the API key
438+
--format=<option> [default: plain] Output format
439+
<options: plain|json|yaml>
440+
--key=<value> API key (prefer interactive prompt for security)
441+
--url=<value> SimpleLogin instance URL (e.g., https://app.simplelogin.io)
442+
443+
DESCRIPTION
444+
Authenticate with SimpleLogin and store credentials
445+
446+
EXAMPLES
447+
$ sl login
448+
449+
$ sl login --url https://app.simplelogin.io
450+
451+
$ sl login --key api-key
452+
```
453+
454+
_See code: [src/commands/login.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/login.ts)_
455+
456+
## `sl logout`
457+
458+
Remove API credentials from config
459+
460+
```
461+
USAGE
462+
$ sl logout [--config <value>] [--format plain|json|yaml]
463+
464+
FLAGS
465+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
466+
--format=<option> [default: plain] Output format
467+
<options: plain|json|yaml>
468+
469+
DESCRIPTION
470+
Remove API credentials from config
471+
472+
EXAMPLES
473+
$ sl logout
474+
475+
$ sl logout --format json
476+
```
477+
478+
_See code: [src/commands/logout.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/logout.ts)_
479+
480+
## `sl whoami`
481+
482+
Check the authenticated user
483+
484+
```
485+
USAGE
486+
$ sl whoami [--config <value>] [--format plain|json|yaml]
487+
488+
FLAGS
489+
--config=<value> [env: SIMPLELOGIN_CONFIG] Path to config file containing credentials
490+
--format=<option> [default: plain] Output format
491+
<options: plain|json|yaml>
492+
493+
DESCRIPTION
494+
Check the authenticated user
495+
496+
EXAMPLES
497+
$ sl whoami
498+
499+
$ sl whoami --format json
500+
```
501+
502+
_See code: [src/commands/whoami.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.0/src/commands/whoami.ts)_
197503
<!-- commandsstop -->

‎package.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@ketrwu/simplelogin-cli",
33
"description": "Unofficial SimpleLogin CLI",
4-
"version": "0.1.0",
4+
"version": "0.1.1",
55
"author": "Kenneth Wußmann",
66
"bin": {
77
"sl": "./bin/run.js"
@@ -59,8 +59,7 @@
5959
"@oclif/plugin-help"
6060
],
6161
"topicSeparator": " ",
62-
"topics": {
63-
}
62+
"topics": {}
6463
},
6564
"repository": "KennethWussmann/simplelogin-cli",
6665
"scripts": {

‎src/commands/alias/create-custom.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {AliasCreateBase} from './alias-create-base.js'
33
import type {AliasApi, Alias} from 'simplelogin-client'
44

55
export default class AliasCreateCustom extends AliasCreateBase {
6+
static override hidden = false
67
static description = 'Create a custom alias with specific prefix and suffix'
78

89
static examples = [

‎src/commands/alias/create.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {AliasCreateBase} from './alias-create-base.js'
33
import type {AliasApi, Alias} from 'simplelogin-client'
44

55
export default class AliasCreate extends AliasCreateBase {
6+
static override hidden = false
67
static description = 'Create a new random alias'
78

89
static examples = [

‎src/commands/alias/delete.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import * as readline from 'node:readline/promises'
66
import {stdin as input, stdout as output} from 'node:process'
77

88
export default class AliasDelete extends BaseCommand<typeof AliasDelete> {
9+
static override hidden = false
910
static description = 'Delete an alias by ID'
1011

1112
static examples = [

‎src/commands/alias/list.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import {AliasListBase} from './alias-list-base.js'
22
import type {AliasApi, AliasModelArray} from 'simplelogin-client'
33

44
export default class AliasList extends AliasListBase {
5+
static override hidden = false
56
static description = 'List all aliases with pagination'
67

78
static examples = [

‎src/commands/alias/search.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import {AliasListBase} from './alias-list-base.js'
33
import type {AliasApi, AliasModelArray} from 'simplelogin-client'
44

55
export default class AliasSearch extends AliasListBase {
6+
static override hidden = false
67
static description = 'Search aliases by email address'
78

89
static examples = [

0 commit comments

Comments
 (0)