the code from the text message
--json JSON output
-h, --help help
Linking is optional. Once linked, the Relay app signs in to this same
account with your phone, and tool approvals from your connected agents
reach you there.
Without a terminal, run it twice: once with --number to get the code, then
again with --number and --code.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
--number your number, with its country code
--code the code from the text message
--json JSON output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Connect an agent](/cli/connect)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# Add a profile
> Add a profile without a token.
Source: https://docs.staging.relayapp.im/cli/reference/profiles-add.md
```bash
npx relaymessenger@staging profiles add
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger profiles add [options]
add a profile without a token
Arguments:
name profile name
Options:
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Authentication](/live/authentication)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# Choose the default profile
> Select the current profile.
Source: https://docs.staging.relayapp.im/cli/reference/profiles-use.md
```bash
npx relaymessenger@staging profiles use
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger profiles use [options]
select the current profile
Arguments:
name profile name
Options:
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Authentication](/live/authentication)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# Remove a profile
> Remove a profile that is not current.
Source: https://docs.staging.relayapp.im/cli/reference/profiles-remove.md
```bash
npx relaymessenger@staging profiles remove
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger profiles remove [options]
remove a profile that is not current
Arguments:
name profile name
Options:
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Authentication](/live/authentication)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# List profiles
> List profiles without their tokens.
Source: https://docs.staging.relayapp.im/cli/reference/profiles-list.md
```bash
npx relaymessenger@staging profiles list
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger profiles list [options]
list profiles without their tokens
Options:
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Authentication](/live/authentication)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# List chats
> List this agent's chats, one page at a time.
Source: https://docs.staging.relayapp.im/cli/reference/chats-list.md
```bash
npx relaymessenger@staging chats list
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger chats list [options]
list this agent's chats, one page at a time
Options:
--cursor the cursor from the previous page
--limit page size
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
--cursor the cursor from the previous page
--limit page size
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Direct and group chats](/chats)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# Show a chat
> Show one chat.
Source: https://docs.staging.relayapp.im/cli/reference/chats-get.md
```bash
npx relaymessenger@staging chats get
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger chats get [options]
show one chat
Arguments:
chat-id the chat ID
Options:
-h, --help help
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Options
```text captured-output
-h, --help help
```
### Global options
```text captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile the saved profile to use
--install-skills Relay skill installation for local runtimes
```
## Exit codes
```text captured-output
relaymessenger exit codes
relaymessenger follows normal conventions regarding exit codes.
- If a command completes successfully, the exit code will be 0
- If a command fails for a reason not covered by exit codes 2–4, the exit code will be 1
- If a command is given options it does not understand, or needs an answer and has no terminal, the exit code will be 2
- If the thing a command names does not exist, the exit code will be 3
- If a command needs a token and none is saved, or Relay does not accept the one it has, the exit code will be 4
Under --json every failure is one JSON object on stderr: {"error", "code", "next_step"}.
The code is Relay's numeric code as a string for an API fault, and one of
usage, not_a_tty, no_token, not_found, network, refused for a fault in this command.
Docs: https://docs.staging.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
```
## Next steps
- [Direct and group chats](/chats)
- [CLI](/cli/index)
- [Global options](/cli/global-options)
# Create a chat
> Create a chat with up to 7 participants.
Source: https://docs.staging.relayapp.im/cli/reference/chats-create.md
```bash
npx relaymessenger@staging chats create
```
{/* Generated by scripts/build-cli-reference.mjs. Do not edit by hand. */}
## Usage
```text captured-output
Usage: relaymessenger chats create [options]
create a chat with up to 7 participants
Options:
--from sender handle
--text the text to send
--rating-request request a rating; send alone
--mention mention this @handle written in --text
--media an https file URL or attachment ID
--link a link with its preview, sent alone
--button