Skip to content
CLI

CLI overview

Neox in the terminal. One command: interactive REPL, one-shot queries, resident daemon.

Install the Neox CLI with npm (npm install -g @mk-co/neox-cli, Node.js 20+; Apple Silicon Macs, Windows x64 and Linux x64). A standalone binary currently ships for macOS (Apple Silicon) only, installed with:

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

That gives you a single neox command — the entry point for the interactive agent, one-shot queries in scripts, and the resident background service. See Installation for details.

Three ways to run

ModeHowFor
REPLneoxDaily chat, long tasks, iterative work
Print modeneox -p "ask", or pipe input inScripts, CI, one-shot queries
Daemon modeneox daemon startResident server shared by multiple clients

The REPL shows an input box, a status line, and an optional background-task bar. See the agents window and shortcuts.

Command structure

neox [global-flags] [subcommand] [subcommand-args]

Common invocations:

neox                                      # REPL
neox -p "do X"                            # one-shot query
neox -p --json "do X" | jq .              # structured output
neox login                                # sign in
neox model ls                             # list models
neox daemon start                         # start the background server

Run neox -h for all flags; the full list is in the command reference.

Inside the REPL

Type / to open command completion, grouped by account, session, process, model, knowledge base, and config.

  • /help — list all commands
  • /model — switch model
  • /session — manage sessions
  • /clear — clear the current conversation and start over
  • /exit — quit

Key environment variables

NEOX_THEME=slate                # colors: neox / slate / warm / mono / nord / neon
NEOX_BG=dark                    # force a light / dark background, skipping auto-detection
NEOX_DEBUG=1                    # more verbose debug output
NEOX_NON_INTERACTIVE=1          # non-interactive
NEOX_DISABLE_AUTO_UPDATE_CHECK=1  # don't check for updates

If HTTP_PROXY or similar proxy variables are set, the CLI follows them and keeps local addresses off the proxy automatically — no need to set NO_PROXY yourself.

Full reference in Files & config.

Relationship to the desktop app

The CLI and the desktop app share one account and one config. Sign in once on each; subscription and quota are shared. Sessions are stored locally.

Which to use

  • Living in the terminal, or over SSH — the CLI
  • Right-pane previews, the built-in browser, and Office file editing — the desktop app
  • CI and script embedding — neox -p print mode