Skip to main content
The nixflex command lets you do from a terminal what you would otherwise do in the dashboard or with the API: create an agent, place a call, load a customer list, check your balance. It ships inside the nixflex npm package - the same package as the Node SDK - and every command is a call into that SDK, so the CLI can never say something the API does not do.

​
Install

Run it without installing (npx nixflex ...), or install once:
Requires Node.js 18 or newer. No other dependencies are installed.

​
Authenticate

The CLI needs your full API key - both halves, nxf_xxx:nxfs_xxx. It looks in three places, in this order:
login stores the key in ~/.nixflex/config.json with owner-only permissions. Never paste a key into a command in a shared shell history - use login or the environment variable.

​
Output

Every command prints a table for humans. Add --json for scripts - the output is then exactly what the API returned, and errors come back as JSON on stdout too:

​
Safety rails

  • Deletes need --confirm. Without it the command shows what would be deleted and stops.
  • Nothing is retried or batched silently. callers import sends your file in chunks of 1,000 and reports the total; a bad row stops the chunk before anything in it is written.
  • Prompts from files. Anywhere a prompt is accepted, @path/to/file.txt reads it from disk instead of the command line.

​
Exit codes

​
Next

Quickstart

An agent, a call and a caller record in two minutes.

Commands

Every command with a real example.