npx relaymessenger help
Usage
captured-output
Usage: relaymessenger help [options] [command]
show what a command does
Arguments:
command command to show help for
Options:
-h, --help help
Docs: https://docs.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
Exit codes
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.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues