Download Neox CLI
Get started

Quick start

Install the CLI, connect a model, send your first message. The shortest path into Neox.

This page walks the smallest complete loop — install the CLI, connect a model, and run your first task. About 3 minutes.

1. Install the CLI

Install with npm (Node.js 20+) on Apple Silicon Macs, Windows x64 and Linux x64:

npm install -g @mk-co/neox-cli

On macOS (Apple Silicon) you can also use the standalone binary, which needs no Node.js:

curl -fsSL https://neox-dev.com/install.sh | sh

It lands in ~/.neox/bin/neox. If that directory is not on your PATH, the installer prints the export PATH=... line to add to ~/.zshrc or ~/.bashrc.

There is no CLI for Intel Macs or Windows ARM64 — use the desktop app from the download page instead (available for macOS and Windows).

Check it worked:

neox --version

2. Connect a model

Two ways in. Pick either one.

A · Bring your own key (BYOK) — no Neox account needed, and Neox charges nothing (you pay the provider for model usage). Run neox provider add (or type /provider inside neox) and add your provider key. In BYOK mode requests go from your device straight to the provider — they never pass through Neox servers, and your key stays encrypted on your machine.

B · Use a Neox subscription — one command:

neox login

This opens your browser for OAuth. On a machine with no browser (SSH, containers) use the device code flow:

neox login --device-code

Credentials are encrypted and stored on your machine. Check which account you are on:

neox whoami

See pricing for what each plan includes.

3. Your first conversation

Interactive — the REPL:

neox

This drops you into the terminal UI. Type your question. /help lists every command, /clear starts a fresh session.

One-shot — print mode (for scripts and CI):

neox -p "Write a Python snippet that reads a CSV"
neox -p --json "List the TypeScript files in this directory" | jq .

4. Pick a model

neox model ls
neox model ls --source=cloud   # only what your subscription covers
neox model ls --source=byok    # only what your own keys cover
neox -p "do X" --model <id>    # run one query on a specific model

Next steps

  • Installing on another machine, the desktop app, or CI? See Installation
  • Working directory, models, providers, environment variables? See Files & config
  • How the agent works and which tools it can call? See Agent overview
  • Something not installing or connecting? See the FAQ