Skip to content

Commands

Core Commands

CommandDescription
nextclaw startStart gateway + UI in the background
nextclaw restartRestart the background service
nextclaw stopStop the background service
sudo nextclaw service install-systemdInstall a managed Linux systemd service
sudo nextclaw service uninstall-systemdRemove the managed Linux systemd service
nextclaw uiStart UI and gateway in the foreground
nextclaw gatewayStart gateway only (for channels)
nextclaw serveRun gateway + UI in the foreground
nextclaw --versionShow the installed NextClaw version
nextclaw statusShow runtime status (--json, --verbose, --fix)
nextclaw doctorRun runtime diagnostics
nextclaw updateSelf-update the CLI

If you expose NextClaw behind Nginx/Caddy/Traefik on a Linux server, use sudo nextclaw service install-systemd instead of relying on a one-time nextclaw start. Otherwise a reboot or exited process can surface as 502 Bad Gateway at the reverse proxy.

Agent Commands

CommandDescription
nextclaw agent -m "message"Send a one-off message
nextclaw agentInteractive chat in the terminal
nextclaw agent --session <id>Use a specific session

Config Commands

CommandDescription
nextclaw config get <path>Get config value
nextclaw config set <path> <value>Set config value (--json)
nextclaw config unset <path>Remove config value
nextclaw initInitialize workspace templates

Secrets Commands

CommandDescription
nextclaw secrets auditAudit configured refs and resolution status (--strict, --json)
nextclaw secrets configure --provider <alias> ...Create/update/remove a provider alias (env/file/exec)
nextclaw secrets apply ...Apply refs/defaults/providers patch (--file or single --path)
nextclaw secrets reloadTrigger runtime secrets reload

See Secrets Management for step-by-step usage and migration examples.

Channel Commands

CommandDescription
nextclaw channels statusShow enabled channels
nextclaw channels loginOpen QR login for supported channels
nextclaw channels add --channel <id>Configure a channel

Plugin Commands

CommandDescription
nextclaw plugins listList discovered plugins
nextclaw plugins install <spec>Install plugin
nextclaw plugins uninstall <id>Uninstall plugin
nextclaw plugins enable <id>Enable plugin
nextclaw plugins disable <id>Disable plugin
nextclaw plugins doctorDiagnose plugin issues

Cron Commands

CommandDescription
nextclaw cron listList all scheduled jobs, including disabled ones
nextclaw cron add ...Add a cron job
nextclaw cron remove <jobId>Remove a job
nextclaw cron enable <jobId>Enable a disabled job
nextclaw cron disable <jobId>Disable a job without deleting it
nextclaw cron run <jobId>Run a job once

Self-Update

bash
nextclaw update

If NEXTCLAW_UPDATE_COMMAND is set, the CLI executes that instead. Otherwise falls back to npm i -g nextclaw.

Released under the MIT License.