npx relaymessenger contact-card update
Usage
captured-output
Usage: relaymessenger contact-card update|set [options]
change this agent's name or picture
Options:
--handle <handle> the agent's handle
--name <name> the display name
--about <text> the line above the first message
--last-name <name> an optional second name
--clear-last-name no second name
--image <path-or-url> a picture file or https:// address
--image-url <url> a picture at an https:// address
--attachment-id <id> the completed attachment
--image-recipe <json-file> a Relay picture recipe accompanying the picture
--clear-image-url no picture
-h, --help help
Docs: https://docs.relayapp.im
Report a problem: https://github.com/RelayMessenger/Relay-SDK/issues
Options
captured-output
--handle <handle> the agent's handle
--name <name> the display name
--about <text> the line above the first message
--last-name <name> an optional second name
--clear-last-name no second name
--image <path-or-url> a picture file or https:// address
--image-url <url> a picture at an https:// address
--attachment-id <id> the completed attachment
--image-recipe <json-file> a Relay picture recipe accompanying the picture
--clear-image-url no picture
-h, --help help
Global options
captured-output
-V, --version the version
--json JSON output
--no-input, --non-interactive no prompts
--agent <auto|yes|no> runtime detection override (default auto)
-q, --quiet errors only
--verbose request method, path, status, milliseconds on stderr
--profile <name> the saved profile to use
--install-skills Relay skill installation for local runtimes
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