Docs/Getting started/Introduction

Welcome to Nium Code

Nium Code is a CLI-first coding agent. It plans, edits, runs tests and opens pull requests across your repository — with every model call priced in dollars and every escalation logged with a reason.

Install the CLI

The Nium CLI works on macOS, Linux and Windows (WSL). Install it globally from npm:

$ npm install -g nium-code

Prefer another package manager?

pnpmpnpm add -g nium-code
yarnyarn global add nium-code
bunbun add -g nium-code

Verify the install:

$ nium --version

Authenticate

Log in once — the CLI stores a rotatable API token in your OS keychain.

$ nium login

A browser window will open. Approve the device and you're done — no config files, no environment variables required.

Your first task

From inside a Git repository, describe what you want in plain language. Nium indexes what matters, quotes a cost range and waits for approval before it changes any code.

$ cd ~/your-repo
$ nium run "replace the in-memory rate limiter with Redis, keep tests green" \
    --cap $1.20

◐ indexing repo · 187 files scanned
✔ retrieved 12 relevant files              $0.03
→ plan approved · 4 files to change        $0.06
✔ patch generated                          $0.19
✔ vitest 41/41 passing                     $0.11
✔ opened PR #482                     total $0.39 / $1.20 cap

Tasks

A task is a single, reviewable unit of work — one plan, one diff, one validation run. Give it a goal, an optional spend cap, and Nium handles the rest.

runnium run "add dark mode toggle"
with capnium run "refactor auth" --cap $2.00
dry runnium run "upgrade to react 19" --plan-only

Model routing

Nium classifies each step of a task and picks the cheapest model likely to succeed. Escalations to a bigger model are logged with a reason you can inspect.

FastSearch, small edits, summarization
MidMulti-file edits, refactors, planning
FrontierAmbiguous work, repeated failures

Pin a tier for deterministic behavior:

pinnium run "..." --tier fast

Budgets & caps

1 credit = $0.01. Every task quotes an estimate before running and hard-stops at the cap you approve. Set a monthly budget for extra safety:

monthly capnium budget set --monthly $50

Security

  • Secrets are redacted locally before any external model call.
  • Destructive shell commands require an explicit confirmation.
  • Every task writes an immutable activity log you can export.
  • Your code is never used to train models.

next

You're ready to ship a task

Open a terminal in any repo and run nium run "...". We'll take it from there.