CLI reference for `zirkabot config` (get/set/unset config values)

Read when…
  • You want to read or edit config non-interactively

zirkabot config

Config helpers: get/set/unset values by path. Run without a subcommand to open the configure wizard (same as zirkabot configure).

Examples

zirkabot config get browser.executablePath
zirkabot config set browser.executablePath "/usr/bin/google-chrome"
zirkabot config set agents.defaults.heartbeat.every "2h"
zirkabot config set agents.list[0].tools.exec.node "node-id-or-name"
zirkabot config unset tools.web.search.apiKey

Paths

Paths use dot or bracket notation:

zirkabot config get agents.defaults.workspace
zirkabot config get agents.list[0].id

Use the agent list index to target a specific agent:

zirkabot config get agents.list
zirkabot config set agents.list[1].tools.exec.node "node-id-or-name"

Values

Values are parsed as JSON5 when possible; otherwise they are treated as strings. Use --json to require JSON5 parsing.

zirkabot config set agents.defaults.heartbeat.every "0m"
zirkabot config set gateway.port 19001 --json
zirkabot config set channels.whatsapp.groups '["*"]' --json

Restart the gateway after edits.