Noddocs

Command reference

All Nod CLI commands at a glance

nod connect

Interactive setup wizard. Configures agent credentials, detects project resources, and sets permission rules.

nod connect

The wizard walks through:

  • Agent ID and Secret (from the Nod app)
  • Working directory selection
  • Resource detection (MCP servers, skills, subagents)
  • Per-agent resource scoping (which MCP servers, skills, subagents to enable)
  • Auto-execute categories (file reads, file edits, shell commands, web access)

Config is saved to ~/.nod/agents/<name>/config.json. A PreToolUse hook and tool scripts are generated for Claude Code.

nod up <agent>

Start an agent as a background service using the OS service manager (launchd on macOS, systemd on Linux).

nod up my-agent

The agent connects to Nod via WebSocket and begins listening for messages and tasks. It persists across terminal sessions and restarts.

nod down <agent>

Stop a running background agent.

nod down my-agent

nod start <agent>

Run an agent in the foreground (this terminal). Useful for debugging.

nod start my-agent

Press Ctrl+C to stop.

nod ps

List all configured agents with their current status.

nod ps

# Output:
# NAME          STATUS      PID     PORT
# my-agent      running     12345   47112
# deploy-bot    stopped     —       —

nod logs <agent>

View agent logs. Follows by default (like tail -f).

nod logs my-agent

nod rm <agent>

Remove an agent. Stops the service and deletes local configuration.

nod rm my-agent
This deletes the local config at ~/.nod/agents/<name>/. The agent still exists on the Nod backend — delete it from the app if you want to remove it completely.

nod status <agent>

Show full agent details including resources, security rules, and session info.

nod status my-agent

nod config <agent>

Interactive configuration menu with three sub-menus:

MenuWhat it configures
ResourcesMCP servers, skills, subagents enabled for this agent
SecurityAllow/deny rules, auto-execute categories
GeneralAgent name, model, working directory
nod config my-agent

nod doctor [agent]

Run diagnostics to verify everything is working.

nod doctor my-agent

Checks:

  • Claude Code is installed and accessible
  • Agent credentials are valid
  • Backend connection is working
  • Config files are present and valid
  • Hook server port is available

Global options

FlagDescription
--help, -hShow help for any command
--version, -vShow CLI version

Environment variables

VariableDefaultDescription
NOD_API_URLhttp://localhost:8000Nod backend API URL
NOD_WS_URLDerived from NOD_API_URLWebSocket URL (auto-derived: http→ws, https→wss)

For production, set NOD_API_URL=https://api.asknod.ai.