NEXAInstaller Guide
Documentation/Installer CLI
Automated Tool Configuration

Nexa Setup CLI

Connect Codex CLI, Codex App / IDE, Claude Code, Claude Desktop, and OpenCode to Nexa with one interactive command. No manual JSON editing or secret exposure required.

Quick Run

Run directly with npx without prior installation:

macOS / Linux / WSL
npx --yes https://api.nexabase.xyz/downloads/nexa-setup-latest.tgz
Windows PowerShell / CMD
npx.cmd --yes https://api.nexabase.xyz/downloads/nexa-setup-latest.tgz

Requirements

  • Node.js 20+ (LTS recommended).
  • A Nexa API key from Dashboard → API keys.
  • The AI client tool you want to connect (Codex, Claude, etc.) installed on your machine.

Supported Clients

ClientIdentifierWhat Gets Configured
Codex CLIcodex-cliConfigures ~/.codex/config.json, preserves existing auth.json.
Codex App / IDEcodex-appConfigures Codex IDE / desktop extensions with Nexa provider.
Claude Codeclaude-codeConfigures Claude CLI provider endpoints and environment.
Claude Desktopclaude-desktopUpdates claude_desktop_config.json with Nexa provider settings.
OpenCodeopencodeConfigures ~/.config/opencode/config.json for openai-compatible gateway.

How It Works

Atomic Backups

Before modifying any tool config file, a timestamped backup is created. If anything fails or you cancel, your original configuration remains untouched.

Automatic Model Sync

On launch, nexa automatically inspects available frontier models and updates tool catalogs with latest context limits and pricing weights.

Secure Key Storage

Keys are masked in the terminal during entry and stored strictly in private user-restricted local files (0600 permissions on Unix).

Process Detection

Detects running client instances and offers to gracefully restart them so new provider credentials take effect immediately.

Managing Settings: nexa set

After the initial run, the nexa command is available in any terminal window. Type:

nexa set

This opens an interactive menu allowing you to:

  • Update or rotate your Nexa API key
  • Toggle automatic model list synchronization
  • Toggle automatic self-updating
  • Select default coding tools

CLI Flags & Non-interactive Mode

FlagDescription
--clients <list>Comma-separated list of clients to configure (e.g. --clients codex-cli,claude-code).
--no-updateSkip the online version and model check for offline or air-gapped environments.
--helpDisplay help and version information.