Skip to content

Commit cfc74e5

Browse files
Fix toc
1 parent 4be897e commit cfc74e5

3 files changed

Lines changed: 473 additions & 22 deletions

File tree

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,35 @@
88
SimpleLogin is an e-mail aliasing service by Proton. This is a third-party CLI tool using [simplelogin-client](https://github.com/KennethWussmann/simplelogin-client) under the hood.
99

1010
<!-- toc -->
11-
* [Installation](#installation)
12-
* [Usage](#usage)
13-
* [Configuration](#configuration)
14-
* [Fetch available signed suffix for the domain](#fetch-available-signed-suffix-for-the-domain)
15-
* [Create the alias](#create-the-alias)
16-
* [Export all enabled aliases to a CSV file](#export-all-enabled-aliases-to-a-csv-file)
17-
* [Create account with unique alias in 1Password](#create-account-with-unique-alias-in-1password)
18-
* [Generate a new alias](#generate-a-new-alias)
19-
* [Create password manager entry with the alias](#create-password-manager-entry-with-the-alias)
20-
* [Commands](#commands)
11+
12+
- [Installation](#installation)
13+
- [Usage](#usage)
14+
* [Automation & Scripting](#automation--scripting)
15+
+ [Why This Matters](#why-this-matters)
16+
+ [Output Format Control](#output-format-control)
17+
+ [Practical Automation Examples](#practical-automation-examples)
18+
- [Extract All Alias Emails](#extract-all-alias-emails)
19+
- [Automated Alias Generation Script](#automated-alias-generation-script)
20+
- [Filter and Export Specific Aliases](#filter-and-export-specific-aliases)
21+
- [Password Manager Integration](#password-manager-integration)
22+
+ [Integration Benefits](#integration-benefits)
23+
- [Commands](#commands)
24+
* [`sl alias create`](#sl-alias-create)
25+
* [`sl alias create-custom PREFIX SUFFIX`](#sl-alias-create-custom-prefix-suffix)
26+
* [`sl alias custom PREFIX SUFFIX`](#sl-alias-custom-prefix-suffix)
27+
* [`sl alias delete ALIAS-ID`](#sl-alias-delete-alias-id)
28+
* [`sl alias list`](#sl-alias-list)
29+
* [`sl alias ls`](#sl-alias-ls)
30+
* [`sl alias options`](#sl-alias-options)
31+
* [`sl alias rm ALIAS-ID`](#sl-alias-rm-alias-id)
32+
* [`sl alias search QUERY`](#sl-alias-search-query)
33+
* [`sl alias update ALIAS-ID`](#sl-alias-update-alias-id)
34+
* [`sl config`](#sl-config)
35+
* [`sl help [COMMAND]`](#sl-help-command)
36+
* [`sl login`](#sl-login)
37+
* [`sl logout`](#sl-logout)
38+
* [`sl whoami`](#sl-whoami)
39+
2140
<!-- tocstop -->
2241

2342
# Installation
@@ -290,7 +309,7 @@ EXAMPLES
290309
$ sl alias create --mode word --note "Shopping" --format json
291310
```
292311

293-
_See code: [src/commands/alias/create.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/create.ts)_
312+
_See code: [src/commands/alias/create.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/create.ts)_
294313

295314
## `sl alias create-custom PREFIX SUFFIX`
296315

@@ -330,7 +349,7 @@ EXAMPLES
330349
$ sl alias create-custom custom suffix789 --mailbox-ids 1,2,3 --format json
331350
```
332351

333-
_See code: [src/commands/alias/create-custom.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/create-custom.ts)_
352+
_See code: [src/commands/alias/create-custom.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/create-custom.ts)_
334353

335354
## `sl alias custom PREFIX SUFFIX`
336355

@@ -403,7 +422,7 @@ EXAMPLES
403422
$ sl alias rm 123 --confirm
404423
```
405424

406-
_See code: [src/commands/alias/delete.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/delete.ts)_
425+
_See code: [src/commands/alias/delete.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/delete.ts)_
407426

408427
## `sl alias list`
409428

@@ -446,7 +465,7 @@ EXAMPLES
446465
$ sl alias list --format json
447466
```
448467

449-
_See code: [src/commands/alias/list.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/list.ts)_
468+
_See code: [src/commands/alias/list.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/list.ts)_
450469

451470
## `sl alias ls`
452471

@@ -529,7 +548,7 @@ EXAMPLES
529548
$ sl alias options --format json
530549
```
531550

532-
_See code: [src/commands/alias/options.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/options.ts)_
551+
_See code: [src/commands/alias/options.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/options.ts)_
533552

534553
## `sl alias rm ALIAS-ID`
535554

@@ -601,7 +620,7 @@ EXAMPLES
601620
$ sl alias search search --format json
602621
```
603622

604-
_See code: [src/commands/alias/search.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/search.ts)_
623+
_See code: [src/commands/alias/search.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/search.ts)_
605624

606625
## `sl alias update ALIAS-ID`
607626

@@ -645,7 +664,7 @@ EXAMPLES
645664
$ sl alias update 123 --note "Shopping" --pinned --format json
646665
```
647666

648-
_See code: [src/commands/alias/update.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/alias/update.ts)_
667+
_See code: [src/commands/alias/update.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/alias/update.ts)_
649668

650669
## `sl config`
651670

@@ -672,7 +691,7 @@ EXAMPLES
672691
$ sl config --format json
673692
```
674693

675-
_See code: [src/commands/config.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/config.ts)_
694+
_See code: [src/commands/config.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/config.ts)_
676695

677696
## `sl help [COMMAND]`
678697

@@ -722,7 +741,7 @@ EXAMPLES
722741
$ sl login --key api-key
723742
```
724743

725-
_See code: [src/commands/login.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/login.ts)_
744+
_See code: [src/commands/login.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/login.ts)_
726745

727746
## `sl logout`
728747

@@ -746,7 +765,7 @@ EXAMPLES
746765
$ sl logout --format json
747766
```
748767

749-
_See code: [src/commands/logout.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/logout.ts)_
768+
_See code: [src/commands/logout.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/logout.ts)_
750769

751770
## `sl whoami`
752771

@@ -770,5 +789,5 @@ EXAMPLES
770789
$ sl whoami --format json
771790
```
772791

773-
_See code: [src/commands/whoami.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.1.3/src/commands/whoami.ts)_
792+
_See code: [src/commands/whoami.ts](https://github.com/KennethWussmann/simplelogin-cli/blob/v0.2.0/src/commands/whoami.ts)_
774793
<!-- commandsstop -->

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"eslint": "^9",
3434
"eslint-config-oclif": "^6",
3535
"eslint-config-prettier": "^10",
36+
"markdown-toc": "^1.2.0",
3637
"mocha": "^10",
3738
"oclif": "^4",
3839
"shx": "^0.3.3",
@@ -71,7 +72,7 @@
7172
"postpack": "shx rm -f oclif.manifest.json",
7273
"pack:tarballs": "oclif pack tarballs",
7374
"posttest": "pnpm run lint",
74-
"prepack": "oclif manifest && oclif readme",
75+
"prepack": "oclif manifest && oclif readme && markdown-toc -i README.md",
7576
"test": "mocha --forbid-only \"test/**/*.test.ts\"",
7677
"version": "oclif readme && git add README.md"
7778
},

0 commit comments

Comments
 (0)