Skip to main content
For the full sample walkthrough see Try the sample agent; for plugin setup see Coding-agent plugins.

​
relai info

Print installed CLI information. 
relai info
Read-only.

​
relai setup

Configure machine-level preferences and RELAI API credentials. 
relai setup [OPTIONS]
Create or manage keys from the API keys page before running non-interactive setup.
OptionDescription
--theme {THEME}Save CLI color theme. Values: light, dark.
--api-url {API_URL}Save the RELAI API URL.
--api-key {API_KEY}Save the RELAI API key.
relai setup
relai setup --theme dark
relai setup --api-url https://api.relai.ai --api-key {key}
Writes ~/.relai/config.toml and local plugin marketplaces under ~/.relai/plugins/. Do not paste or commit API keys. Common failures: invalid credentials, missing required tools, non-interactive runs without enough flags, or permission issues writing home-directory config.

​
relai update

Update the installed CLI to the latest release. 
relai update
relai update --force
Use --force to reinstall even when the current version already matches the latest release. Common failures: unsupported platform, missing release artifact, network failure, checksum failure, or permission issues replacing the binary.

​
relai onboarding

Clone the finance-agent sample and print a guided onboarding flow. 
relai onboarding
relai onboarding --destination ~/relai-onboarding-agent
Creates a disposable local sample directory. Use it when you want to try RELAI before running it on your own agent project. Common failures: destination path already exists, network failure, or GitHub access failure.

​
relai plugins install

Install or refresh local RELAI plugin marketplaces for coding agents. 
relai plugins install
relai plugins install --agent codex
relai plugins install --agent claude
OptionDescription
--agent {AGENT}Marketplace to install. Values: all, codex, claude. Default: all.
Writes under ~/.relai/plugins/ and prints follow-up commands for Codex or Claude Code. It does not modify those tools unless you run the printed commands.

​
relai completions

Generate shell completion scripts. 
relai completions bash
relai completions zsh
relai completions fish
Prints the completion script to stdout. It is read-only unless you redirect the output into a shell config path.