Install

Install on Windows

Windows 10 and 11 on Windows x64 or Windows ARM64, in a 64-bit Windows PowerShell 5.1 or PowerShell 7 window.

1. Downloads the native executable for your architecture.
2. Checks its size and SHA-256 against the release manifest and checksum sidecar, then proves --version.
3. Installs %USERPROFILE%\.rightnow\bin\rightnow.exe by default and keeps the previous binary as rightnow.exe.old for rollback.
4. Writes installer.toml in the product home, writes PowerShell completions when generation succeeds, and prepends the bin directory to your user PATH.

An older PATH entry or shell alias can still take precedence. Check which executable PowerShell resolves:

Get-Command rightnow -All

Install on macOS and Linux

macOS Apple Silicon, macOS Intel, Linux x64 and Linux ARM64. The installer needs bash 3.2 or newer, curl or GNU wget, and sha256sum or shasum.

macOS

Linux

Linux binaries are static with no glibc requirement. The Linux installer verifies SHA-256 against the checksum sidecar.

What the installer does

1. Verifies SHA-256 against the checksum sidecar. With Python 3 or jq it also checks the release manifest and file size; without either, it reports sidecar-only verification.
2. Proves --version, installs ~/.rightnow/bin/rightnow by default, and keeps the previous binary for rollback.
3. Writes installer.toml in the product home, plus bash, zsh and fish completions when generation succeeds.
4. Reuses a bin directory already on PATH or links into a writable PATH directory: ~/.local/bin, ~/bin, or /usr/local/bin. For bash, zsh, or fish, it otherwise writes the shell startup file and prints its path.

Follow the printed PATH line: open a new terminal, or load the changed startup file in this one.

• zshsource "${ZDOTDIR:-$HOME}/.zshrc"
• bashsource "$HOME/.bashrc"
• fishsource $__fish_config_dir/config.fish

Check that your shell finds the command:

command -v rightnow

Git Bash on Windows delegates to PowerShell. WSL uses the Linux binary.

Proxy or private CA

On macOS and Linux, the installer's downloads honor HTTPS_PROXY or https_proxy, and NO_PROXY or no_proxy. For a private CA, set RIGHTNOW_EXTRA_CA_BUNDLE to your trusted PEM CA bundle before installing. The installer ignores ~/.curlrc and ~/.wgetrc. If a download fails, see Troubleshooting.

Verify

Open a new terminal after installation. On macOS and Linux, follow the installer PATH instructions first. Run rightnow --version, then rightnow doctor. Values in angle brackets vary by release.

PS> rightnow --versionCopy
# Installed version format (excerpt)
rightnow <version> (<commit>)

Doctor checks terminal, clipboard, color, and input support. Its endpoint section reads configuration only; it does not validate provider credentials or connectivity.

PS> rightnow doctorCopy
# Healthy terminal configuration (excerpt)
RightNow Doctor

Checks not completed
  ? runtime.fullscreen-active    unavailable
  ? runtime.kitty-flags-pushed   unavailable

Needs a running session
  Some checks only run in RightNow. Start RightNow and run /doctor.

0 issues, 0 recommendations

A completed Doctor report exits with code 0 even when it lists issues or recommendations; a Doctor error exits with code 1. Run /doctor in a session for the checks that need the running TUI.

• Shell cannot find rightnow: finish the PATH steps above.
• Missing provider key: connect a provider.
• Terminal findings: Troubleshooting.

Then run rightnow for the TUI or rightnow -p "task" for one task. The Quickstart walks through both.

Optional settings

Set these in the shell that runs the installer. On macOS and Linux, export them so bash receives them.

• RIGHTNOW_VERSIONPin a published version. Unset, the installer follows the selected channel pointer.
• RIGHTNOW_CHANNELstable (default) or alpha.
• RIGHTNOW_HOMEProduct home for downloads, completions, and installer state. Keep it set when you launch the CLI.
• RIGHTNOW_BIN_DIRBin directory. The default is the product home's bin directory.
• RIGHTNOW_NO_PATH_UPDATEOn Windows, 1 or true leaves the user PATH unchanged.

$env:RIGHTNOW_CHANNEL = "alpha"
$env:RIGHTNOW_BIN_DIR = "C:\tools\RightNow"

export RIGHTNOW_CHANNEL="alpha"

Nonempty RIGHTNOW_HOME takes precedence over GROK_HOME. GROK_BIN_DIR, GROK_VERSION, and GROK_CHANNEL are fallback aliases; the matching RIGHTNOW_* setting wins. With neither home variable set, an existing legacy ~/.grok home stays in use when ~/.rightnow is absent and ~/.grok/config.toml exists. See Configuration.

Shell completions

When generation succeeds, the installer writes completion scripts under completions in the product home and prints how to enable each one. Generating a file does not enable it in the current shell.

If generation was skipped, these commands print the completion script for the selected shell:

• PowerShellrightnow completions powershell
• bashrightnow completions bash
• zshrightnow completions zsh
• fishrightnow completions fish

Update

The shipped configuration sets [cli] auto_update = false, so update explicitly:

• rightnow update --check --jsonReport the available update without installing it. --json requires --check.
• rightnow updateUpdate on the current channel.
• rightnow update --alphaSwitch to the alpha channel and update.
• rightnow update --stableSwitch to the stable channel and update.
• rightnow update --force-reinstallDownload and reinstall even when already up to date.
• rightnow update --version "<published-version>"Install that exact published version; replace the placeholder.

An explicit [cli] channel in the config takes precedence over RIGHTNOW_CHANNEL, then its legacy alias, then the channel in installer.toml, with stable as the default. Updates follow channel pointers and can downgrade when a channel rolls back.

On Windows, never run rightnow.exe.old directly. Manual rollback requires verifying a copy of the retained backup before restoring it, then a verified pinned install to reconcile installer.toml.

Build from source

The agent source is not published. Enterprise customers can ask us about source access. Authorized repository contributors on Windows, macOS, or Linux need the Rust toolchain pinned by rust-toolchain.toml. On Windows, enable Git long-path support if needed for a deep checkout.

Build from the repository root:

cargo build -p rightnow-pager-bin --release

Run the launchers from the repository root. For subcommands such as doctor, call rightnow-pager.exe <subcommand> (on macOS and Linux, target/release/rightnow-pager) directly: the launchers append a tool-deny flag after every command except leader and daemon, and some subcommands, such as doctor, reject it.

The build resolves protoc from PROTOC, the repository wrapper (which needs dotslash), PATH, then the vendored executable, so no separate protoc installation is required.

The source launcher seeds a missing user config from config/rightnow.toml. Older valid configs are backed up and upgraded while preserving owner values, with a Windows exception. On Windows, the upgrade re-pins turn_time_budget_secs, turn_model_call_limit, turn_repeated_failure_limit, and act_first when they differ from the template during an upgrade from a config version below 6 to version 6 or newer. See the configuration synchronization rules. A provider credential is needed to run model-backed tasks, not to build.

Related

• Connect a provider
• Run your first task
• Troubleshooting