Skip to content

Commit 4dbcd15

Browse files
authored
docs(snippet): update command reference (#10)
1 parent 3385178 commit 4dbcd15

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

docs/documentation/community/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Check out the answers to the most frequently asked questions about Relay. If you
1212
</Accordion>
1313

1414
<Accordion title="How do I get started?">
15-
Install the CLI with `pip install relaycli`, then run `relay account add` to connect your first email account.
15+
Install the CLI with `pip install relaycli`, then run `relay accounts add` to connect your first email account.
1616
The [quickstart guide](/documentation/getting-started/quickstart) walks you through the entire setup in under 5 minutes.
1717
</Accordion>
1818

@@ -43,7 +43,7 @@ Check out the answers to the most frequently asked questions about Relay. If you
4343
</Accordion>
4444

4545
<Accordion title="Can I manage multiple email accounts?">
46-
Yes! Connect unlimited email accounts with `relay account add` and switch between them or manage them all simultaneously.
46+
Yes! Connect unlimited email accounts with `relay accounts add` and switch between them or manage them all simultaneously.
4747
Each account gets its own secure credential storage.
4848
</Accordion>
4949

docs/reference/cli/accounts.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ For Gmail, you'll need to use an App Password instead of your regular password.
8989
Display all configured email accounts in a formatted table.
9090

9191
```shell
92-
relay account list
92+
relay accounts list
9393
```
9494

95-
**Alias:** `relay account ls`
95+
**Alias:** `relay accounts ls`
9696

9797
The output shows:
9898
- Account name
@@ -112,15 +112,15 @@ Remove an account and its stored credentials from your system.
112112
<Tabs>
113113
<Tab title="With Confirmation">
114114
```shell
115-
relay account remove work
115+
relay accounts remove work
116116
```
117117

118118
The CLI will ask for confirmation before removing the account.
119119
</Tab>
120120

121121
<Tab title="Force Removal">
122122
```shell
123-
relay account remove work --force
123+
relay accounts remove work --force
124124
```
125125

126126
**Aliases:** `--force`, `-f`, `-y`
@@ -138,7 +138,7 @@ This action is irreversible. You'll need to re-add the account if you want to us
138138
Verify that your account credentials are working and the server is reachable.
139139

140140
```shell
141-
relay account test work
141+
relay accounts test work
142142
```
143143

144144
This command will:

relay/cli/commands/messages.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def _get_account_manager_and_client(account: str) -> tuple[AccountManager, Any,
4949
if not account:
5050
accounts = manager.list_accounts()
5151
if not accounts:
52-
console.print("[red]✗ No accounts configured. Use 'relay account add' to add an account.[/red]")
52+
console.print("[red]✗ No accounts configured. Use 'relay accounts add' to add an account.[/red]")
5353
raise typer.Exit(1)
5454
account = accounts[0].name
5555
console.print(f"[dim]Using account: {account}[/dim]")
@@ -73,7 +73,7 @@ def wrapper(*args, **kwargs):
7373
return func(*args, **kwargs)
7474
except AccountNotFoundError as e:
7575
console.print(f"[red]✗ {e}[/red]")
76-
console.print("[dim]Use 'relay account list' to see available accounts[/dim]")
76+
console.print("[dim]Use 'relay accounts ls' to see available accounts[/dim]")
7777
raise typer.Exit(1)
7878
except AuthenticationError as e:
7979
console.print(f"[red]✗ {e}[/red]")

scripts/install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ main() {
108108

109109
log ""
110110
log "🎉 Relay CLI installed successfully!"
111-
log "Run 'relay account add' to get started"
111+
log "Run 'relay accounts add' to get started"
112112
log "Documentation: https://docs.relaycli.com"
113113
}
114114

0 commit comments

Comments
 (0)