chore: updated docs
2a742692
2 file(s) · +28 −8
| 1 | 1 | # CLI Reference |
|
| 2 | 2 | ||
| 3 | + | ## `login` |
|
| 4 | + | ||
| 5 | + | ```bash [Terminal] |
|
| 6 | + | sequoia login |
|
| 7 | + | > Login with OAuth (browser-based authentication) |
|
| 8 | + | ||
| 9 | + | OPTIONS: |
|
| 10 | + | --logout <str> - Remove OAuth session for a specific DID [optional] |
|
| 11 | + | ||
| 12 | + | FLAGS: |
|
| 13 | + | --list - List all stored OAuth sessions [optional] |
|
| 14 | + | --help, -h - show help [optional] |
|
| 15 | + | ``` |
|
| 16 | + | ||
| 17 | + | OAuth is the recommended authentication method as it scopes permissions and refreshes tokens automatically. |
|
| 18 | + | ||
| 3 | 19 | ## `auth` |
|
| 4 | 20 | ||
| 5 | 21 | ```bash [Terminal] |
|
| 6 | 22 | sequoia auth |
|
| 7 | - | > Authenticate with your ATProto PDS |
|
| 23 | + | > Authenticate with your ATProto PDS using an app password |
|
| 8 | 24 | ||
| 9 | 25 | OPTIONS: |
|
| 10 | 26 | --logout <str> - Remove credentials for a specific identity (or all if only one exists) [optional] |
|
| 13 | 29 | --list - List all stored identities [optional] |
|
| 14 | 30 | --help, -h - show help [optional] |
|
| 15 | 31 | ``` |
|
| 32 | + | ||
| 33 | + | Use this as an alternative to `login` when OAuth isn't available or for CI environments. |
|
| 16 | 34 | ||
| 17 | 35 | ## `init` |
|
| 18 | 36 | ||
| 31 | 31 | sequoia |
|
| 32 | 32 | ``` |
|
| 33 | 33 | ||
| 34 | - | ### Authorize |
|
| 35 | - | ||
| 36 | - | In order for Sequoia to publish or update records on your PDS, you need to authorize it with your ATProto handle and an app password. |
|
| 34 | + | ### Login |
|
| 37 | 35 | ||
| 38 | - | :::tip |
|
| 39 | - | You can create an app password [here](https://bsky.app/settings/app-passwords) |
|
| 40 | - | ::: |
|
| 36 | + | In order for Sequoia to publish or update records on your PDS, you need to authenticate with your ATProto account. |
|
| 41 | 37 | ||
| 42 | 38 | ```bash [Terminal] |
|
| 43 | - | sequoia auth |
|
| 39 | + | sequoia login |
|
| 44 | 40 | ``` |
|
| 41 | + | ||
| 42 | + | This will open your browser to complete OAuth authentication, and your sessions will refresh automatically as you use the CLI. |
|
| 43 | + | ||
| 44 | + | :::tip |
|
| 45 | + | Alternatively, you can use `sequoia auth` to authenticate with an [app password](https://bsky.app/settings/app-passwords) instead of OAuth. |
|
| 46 | + | ::: |
|
| 45 | 47 | ||
| 46 | 48 | ### Initialize |
|
| 47 | 49 |