Docs

NaN CLI.

NaN has an official terminal tool, helmcode/nan-cli. It does two things: it shows you your real usage, and it configures your coding tools for you, without you having to edit configuration files by hand.

It is a shortcut, not a requirement. Everything it does can be done by hand by following your tool’s page in this same section.

What it configures on its own

ToolAutomatic setup
OpenCodeYes
CodexYes
PiYes
Factory AI (droid)Yes

Claude Code, Cursor, VS Code, Cline and Zed still need the manual configuration from their pages.

What else you get

The CLI opens a panel with tabs you move through with the arrow keys:

TabWhat for
ProfileYour account details
UsageTokens spent over 24 hours, 30 days and all time
ModelsThe models available and how much you have spent on each
CostsWhat the same thing would have cost you at other providers
SetupYour API key and the automatic setup of tools
AboutVersion and links

The Usage tab is the fastest way to know how much quota you have left before starting a long agent session.

Installation

Install the binary

On macOS and Linux, one line:

curl -fsSL https://nan.builders/install | bash

The installer looks at your system and architecture, downloads the right binary from the latest published release, verifies its checksum and puts it in /usr/local/bin/nan. If that directory needs administrator rights, it will ask for your password through sudo.

To put it somewhere else, give it the directory yourself:

INSTALL_DIR="$HOME/.local/bin" curl -fsSL https://nan.builders/install | bash

If the directory you choose is not in your PATH, the installer says so and hands you the line to add to your ~/.zshrc or your ~/.bashrc.

There are binaries for macOS and Linux, on Intel and on ARM. On Windows you have to build from source for now, and the block below explains how.

Check that it worked

nan --version

It has to answer with the version and the name of the tool. If your terminal says the command is not found, the binary is installed but its directory is not in your PATH.

Get your API key

At cloud.nan.builders, in your user settings, under API Keys.

Do not use nan auth login

That command points to a Discord sign-in address that no longer exists and ends in a 404 in your browser. It is not your machine’s fault. The good path is to take the key from the panel and paste it into the Setup tab.

Configure your tools

nan

Inside the panel, go to the Setup tab with the arrow keys. Press e and paste your API key. With space, mark the tools you want configured. Press c to apply.

The CLI writes the configuration for each tool you marked. Quit with q and start your agent:

opencode

Inside OpenCode, /models shows you the NaN models, already available.

Building from source

This is the path on Windows, and the one you want if you are going to work on the CLI itself. You need Go 1.26 or newer:

git clone https://github.com/helmcode/nan-cli
cd nan-cli
go build -o nan .

That leaves the binary in the repository directory. To have it at hand from anywhere, move it to a directory in your PATH:

mkdir -p ~/.local/bin
mv ./nan ~/.local/bin/nan

If that directory is not in your PATH yet, add it to your shell’s startup file. On macOS the default shell is zsh, so the file is ~/.zshrc and not ~/.bashrc:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

On Linux with bash, the same command but against ~/.bashrc.

Updating

Run the installer again. It always brings the latest published release and overwrites the one you have:

curl -fsSL https://nan.builders/install | bash

To remove it, delete the binary: rm /usr/local/bin/nan, or whatever path you gave it with INSTALL_DIR. It leaves nothing else behind on your system.

If you would rather not install anything

That is perfectly reasonable. Go straight to your tool’s page and copy the configuration block:

The result is the same. The only thing you miss out on are the usage and cost tabs.

Known issues
  • Profile, Usage and Costs need a session that cannot be created today. The CLI’s Discord sign-in points to a retired endpoint. The Setup tab, which is the one that configures your tools, works with the API key alone and is unaffected.
  • On Windows you have to build. The published releases carry macOS and Linux binaries; for Windows, the path for now is go build.
  • The installer asks GitHub for the list of releases. If you are behind a proxy that blocks api.github.com, it will find nothing to download. In that case, grab the .tar.gz for your system by hand from the releases page.
nan.builders © 2026
Copied to clipboard