CLI Reference
All NeuralCleave commands are invoked as neuralcleave <command> [subcommand] [flags]. Every command that talks to the running gateway reads the bind address from config.toml (or --host/--port flags).
The CLI entry-point is neuralcleave. If using a dev install (pip install -e .), the entry-point is registered by the [project.scripts] table in pyproject.toml.
neuralcleave start
$ neuralcleave start [flags]
Start the gateway. Blocks in the foreground unless
--background is set.--background, -bDetach and run as a daemon; PID written to
~/.neuralcleave/gateway.pid--host TEXTBind address (overrides config)
--port INTEGERPort (overrides config)
--config PATHPath to config.toml (overrides default)
--log-level TEXTDEBUG | INFO | WARNING | ERROR
neuralcleave stop
$ neuralcleave stop
Send SIGTERM to the background daemon identified by
~/.neuralcleave/gateway.pid.neuralcleave status
$ neuralcleave status
Print agent name, primary model, gateway URL, enabled channels, memory backend status, and SQLite row count.
neuralcleave init
$ neuralcleave init [flags]
Interactive setup wizard. Writes
~/.neuralcleave/config.toml.--non-interactive, -ySkip all prompts; write config with sane defaults
neuralcleave chat
$ neuralcleave chat [flags]
Open an interactive terminal chat session with the running agent. Uses the WebSocket protocol internally.
--session-id TEXTResume a specific session by ID
--model TEXTOverride model for this session
neuralcleave plugins
$ neuralcleave plugins list
List all loaded plugins, their tools, and load status.
$ neuralcleave plugins reload [NAME]
Hot-reload a plugin (or all plugins if NAME is omitted) without restarting the gateway.
neuralcleave hub
$ neuralcleave hub list [--tag TAG] [--search QUERY]
List packages in the local Hub registry.
$ neuralcleave hub search QUERY
Search available Hub packages by name or tag.
$ neuralcleave hub install NAME [--url URL] [--force]
Install a Hub package. Runs PackageScanner safety check before install.
--force bypasses the scanner (requires explicit user intent).$ neuralcleave hub remove NAME
Uninstall a Hub package and deregister it from the registry.
$ neuralcleave hub scan PATH
Run PackageScanner on a local file or directory without installing.
neuralcleave orchestrate
$ neuralcleave orchestrate list
List all registered orchestrator nodes and their routing config.
$ neuralcleave orchestrate add NAME --model MODEL [--task-types LIST] [--priority N]
Register a new orchestrator node.
$ neuralcleave orchestrate route --task TYPE [--channel NAME]
Test routing — show which node would handle a given task type and channel.
$ neuralcleave orchestrate status
Show orchestrator health and per-node request counters.
neuralcleave voice
$ neuralcleave voice listen [flags]
Start the continuous voice listener. Captures speech, sends to Whisper STT, forwards to the agent.
--model TEXTWhisper model size (default: base)
--threshold-rms FLOATRMS energy threshold for VAD (default: 0.02)
--silence-s FLOATSeconds of silence to end an utterance (default: 0.8)
--device TEXTInput device name or index
--language TEXTLanguage hint for Whisper (e.g. "en", "ja")
$ neuralcleave voice clone NAME FILES...
Clone a voice from audio files and store the ElevenLabs
voice_id.neuralcleave autostart
$ neuralcleave autostart enable
Register NeuralCleave to start at OS login. Platform-specific: Windows registry, macOS launchd, Linux systemd user.
$ neuralcleave autostart disable
Remove the autostart registration.
$ neuralcleave autostart status
Show whether autostart is currently registered.
neuralcleave canvas
$ neuralcleave canvas open
Open the live canvas page in the default browser (
http://localhost:7432/canvas).$ neuralcleave canvas status
Show block count and connected WebSocket viewers.
$ neuralcleave canvas clear
Clear all canvas blocks and broadcast the clear event to connected viewers.
neuralcleave cloud
$ neuralcleave cloud generate [--platform PLATFORM]
Write deployment manifests for Railway, Render, Fly, Heroku, or DigitalOcean. Auto-detects the platform from environment variables if not specified.
$ neuralcleave cloud check
Validate that Docker and docker-compose are installed and the Dockerfile builds correctly.
$ neuralcleave cloud status
Show the detected cloud platform and whether required environment variables are set.
neuralcleave skills
$ neuralcleave skills list
List all dynamically written skills in
~/.neuralcleave/skills/.$ neuralcleave skills show NAME
Print the source code of a skill.
$ neuralcleave skills validate NAME
Run PackageScanner safety checks on a skill without loading it.
$ neuralcleave skills delete NAME
Delete a skill file and unload it from the running PluginRegistry.
neuralcleave sandbox
$ neuralcleave sandbox status [--backend local|docker|ssh]
Show whether the sandbox backend is available and configured.
$ neuralcleave sandbox test [--backend local|docker|ssh]
Run a quick smoke test (echo command) through the sandbox backend.