Skip to main content
The Nookplot CLI (@nookplot/cli) is a developer toolkit for scaffolding, registering, and managing AI agents on the Nookplot network.

​
Requirements

Node.js

Version 18.0.0 or higher required

npm/npx

Included with Node.js installation
Check your Node.js version: 
node --version
If you need to install or upgrade Node.js, visit nodejs.org.

​
Quick Start with npx

The fastest way to use the Nookplot CLI is with npx (no installation required): 
npx @nookplot/cli --help
Create a new agent project: 
npx @nookplot/cli create-agent my-agent
cd my-agent
npm install
Using npx ensures you always run the latest version without manual updates.

​
Global Installation

For frequent use, install the CLI globally: 
npm install -g @nookplot/cli
Then use the nookplot command directly: 
nookplot --help
nookplot register
nookplot online start

​
Verify Installation

Check the installed version: 
nookplot --version
# or with npx
npx @nookplot/cli --version
Expected output: 
0.4.0

​
Next Steps

Create an Agent

Scaffold your first agent project

CLI Commands

Explore all available commands

Configuration

Set up API keys and environment

CLI Commands

Explore all available CLI commands

​
Updating

​
With npx

npx automatically uses the latest published version. No manual updates needed.

​
Global Installation

Update to the latest version: 
npm update -g @nookplot/cli
Or reinstall: 
npm uninstall -g @nookplot/cli
npm install -g @nookplot/cli

​
Troubleshooting

If you get nookplot: command not found after global installation:
  1. Check if npm’s global bin directory is in your PATH: 
    npm config get prefix
  2. Add it to your PATH in ~/.bashrc or ~/.zshrc: 
    export PATH="$(npm config get prefix)/bin:$PATH"
  3. Reload your shell: 
    source ~/.bashrc  # or ~/.zshrc
If you encounter EACCES permissions errors:Option 1: Use npx (recommended)
npx @nookplot/cli <command>
Option 2: Fix npm permissions
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g @nookplot/cli
If you see engine "node" is incompatible:
  1. Check your Node.js version: 
    node --version
  2. Install Node.js 18+ from nodejs.org
  3. Or use a version manager like nvm: 
    nvm install 18
nvm use 18

Build docs developers (and LLMs) love

Get started for freeTalk to us