Quickstart
Get started

Quickstart

2. Quickstart#

The fastest path is a Rayu account: sign in once and Rayu's hosted models are ready to use — no provider keys, no per-provider setup.

1. Install and start#

bash
rayu

(Not installed yet? See Installation.)

The first launch walks you through two short steps: pick a terminal theme, then choose how to authenticate.

2. Sign in#

RayuCode asks you to choose a Rayu credential:

  1. Sign in with Rayu account — opens your browser (recommended)
  2. Enter Rayu API key — paste a key from rayucode.com/dashboard/api-keys

Choose the first one. Rayu opens your browser, you approve, and the terminal finishes on its own.

You can do the same thing from the shell at any time:

bash
rayu login --provider rayu

What just happened:

  • Your session is stored on your machine in ~/.rayu/rayu-auth.json and is refreshed automatically. Sign out with /logout.
  • If a browser cannot open (SSH, WSL, containers), Rayu prints the sign-in URL for you to copy, or you can run rayu login --provider rayu --no-browser to get a QR code for another device.
  • The Rayu hosted provider is activated automatically, so its models show up in /model with no further setup. See Subscription plans.

For headless or CI use, skip the browser entirely:

bash
export RAYU_API_KEY=rayu_sk_live_...
rayu run "Say hello from rayu"

A Rayu API key and a Rayu account session are two ways to present the same credential; you do not need both.

3. Pick a model#

text
/model

The picker lists every model your plan allows, read live from Rayu's catalog. Type to filter, ↑/↓ to move, Enter to choose, Esc to cancel. Your choice appears in the status line and persists across sessions.

You can also pick directly:

text
/model deepseek-v4.1-flash-cloud

or at launch:

bash
rayu --model deepseek-v4.1-flash-cloud

The catalog is live, so a newly added or renamed model appears without updating rayu. See Models.

4. Ask for your first task#

text
> explain what this project does and list its main modules

Rayu streams its answer, reads files, and edits them with visible diffs. Use:

KeyAction
EnterSend the prompt
Shift+Enter or \ then EnterInsert a newline
EscStop the current turn (the partial answer is kept)
Ctrl+C twiceExit
Shift+TabCycle your favorite models
Ctrl+TabToggle queue mode (send without interrupting)

Type / to open the command menu and /help to see every command and key.

5. Useful first commands#

CommandAction
/modelSearch and switch models
/effort <level>Set reasoning effort (low, medium, high, max, …)
/usageCredits and plan usage for connected providers
/accountOpen the account picker; /account rayu status shows plan and credits
/contextShow the full context snapshot for this session
/compactSummarize older messages to free context
/clearStart a fresh conversation
/resumeBrowse and resume earlier sessions
/quitExit

6. Resume and branch#

  • rayu --resume with no ID opens the session picker.
  • rayu --resume <id> resumes a specific session.
  • /resume does the same from inside a session.
  • /fork opens the current conversation in a new window, leaving this one untouched.

Sessions are stored per project under ~/.rayu/sessions. See Sessions & checkpoints.

7. Run one prompt from a script#

Non-interactive use is a subcommand in v3, not a flag:

bash
rayu run "write a one-line summary of package.json"
rayu run --json "list the top-level modules" | jq -r '.text'

rayu run signs in with the same credential as the interactive UI, prints the answer, and exits with 0 on success. See Headless & CI for the JSON and NDJSON event shapes.

In VS Code instead?#

RayuCode is the same engine inside VS Code. Sign-in is per surface: the extension keeps its own auth profile, so signing into the terminal does not sign you into the editor, or the other way round. Sessions, settings, skills and project instructions in ~/.rayu are shared. See VS Code extension.

Which providers does this build support?#

Public RayuCode v3 builds are Rayu-only: the only provider is Rayu, reached with an account session or a Rayu API key. Everything in this documentation is written for that build.

Sources built with ENABLE_OTHER_PROVIDER=true additionally accept Anthropic, OpenAI, Google, DeepSeek and other provider keys through rayu login <provider>, and the extra commands appear in /help. If a command in the provider docs is missing, your binary was built Rayu-only. See Providers.

Next: Providers →