Skip to main content

Install

Initialize a Workspace

This creates the minimal canonical layout in ~/.chainbot:
Set CHAINBOT_CONFIG_DIR to initialize somewhere else:

Check Workspace Status

The status command is non-executing. It shows root, daemon health, workflow summaries, and trigger state without triggering runs.

Run a Workflow

When the workspace has exactly one workflow package, run executes it directly. When multiple workflows exist, run infers the top-level workflow if exactly one is reachable without being referenced as a subflow. For structured output, use:

Validate Configuration

Before running, validate the workspace layout and all manifest contracts:

Run the Daemon

To start long-running trigger evaluation:
The daemon reloads config on each loop boundary and persists health to the coordination database.

Observe Runtime History

The observe command provides read-only access to persisted run summaries, workflow logs, and trigger events. It does not modify active or archived history.

List Run History

Outputs JSON with persisted run summaries.

Manage Triggers

Trigger mutations take effect on the next status, validate, serve, or run.

Stop the Daemon

Requests graceful shutdown. Returns a stable result even if the daemon is already inactive.

Help

help <command> returns structured information including usage, reads/writes, contract examples, failure navigation, and related commands.