Covendocs
CLI ReferenceCLI Reference

CLI Reference

First-class reference for the coven command and the current Coven CLI command surface.

4 min read

The user-facing command is coven. OpenCoven is the ecosystem and package namespace; Coven is the local runtime and command-line product.

Run coven with no arguments when you want the guided interactive shell. Use explicit subcommands when you want a scriptable or copy-paste path.

Command map

Every row below is a real top-level coven verb. Grouped reference pages cover subcommands, flags, and examples.

Core and sessions

CommandUse it for
covenOpen the interactive chat/shell when stdin/stdout are a terminal.
coven chatOpen the interactive Coven UI explicitly (requires the coven-code engine).
coven tuiSame as coven chat. See Interactive shell.
coven doctorCheck local setup and print next steps; exits 1 when a blocking problem is found.
coven config paths --jsonReport resolved state, settings, engine, and local IPC paths without creating profile state.
coven completions <shell>Generate shell completions (bash, zsh, fish, elvish, powershell).
coven daemon startStart the local daemon process.
coven daemon statusInspect daemon pid, socket, and health state.
coven daemon restartRebind the local socket after changes or stale state.
coven daemon stopStop the local daemon.
coven run codex "fix tests"Launch a project-scoped Codex harness session.
coven run claude "polish this UI"Launch a project-scoped Claude Code harness session.
coven sessionsBrowse, attach, view, archive, summon, or sacrifice sessions.
coven sessions --allInclude archived sessions.
coven sessions --manageForce the interactive session browser.
coven sessions --plainPrint a plain table for scripts or copying.
coven sessions --jsonPrint a JSON sessions array for clients.
coven attach <session-id>Replay/follow a session and forward input to live daemon sessions.
coven summon <session-id>Restore an archived session, then attach.
coven archive <session-id>Hide a completed session while preserving events.
coven sacrifice <session-id> --yesPermanently delete a non-running session and its event log.
coven kill <session-id>Kill a running session's process; its event log is kept.
coven patch openclawLaunch the guided repair flow for a registered repo.

Observability and store maintenance

CommandUse it for
coven statusShow what's happening across your coven: daemon, sessions, familiars, skills, research, hub.
coven familiarsList the familiar roster from ~/.coven/familiars.toml.
coven skillsList installed skills from ~/.coven/skills/.
coven memoryList familiar memory files from ~/.coven/memory/.
coven researchShow the research loop log from ~/.coven/research/.
coven callsShow the Coven Calls delegation ledger.
coven logs pruneManage local log retention.
coven vacuumRepair and compact the local Coven session store.
coven resetPreview or recoverably reset selected local state categories; --apply moves them into a backup.
coven pcDiagnose and relieve macOS system pressure. See PC Diagnostics.

All of these except coven pc are covered on Observability commands.

Hub and scheduling

CommandUse it for
coven hubInspect the multi-host hub control plane (read-only).
coven schedulerInspect multi-host scheduler decisions and loop recovery (read-only).
coven travelInspect travel-mode handoff state (read-only).
coven executorStateless executor-node protocol commands, hub-dispatched over SSH or a private network.

Covered on Hub and scheduling.

Engine and auth

CommandUse it for
coven engineManage the Coven engine (the interactive agent runtime).
coven authManage model provider credentials (Anthropic, Codex) — runs in the Coven engine.
coven modelsList available models — runs in the Coven engine.
coven acpStart the Agent Client Protocol server (stdio JSON-RPC) — runs in the Coven engine.
coven codeRun any Coven engine subcommand directly (escape hatch).

Covered on Engine and auth.

Repo workflow

CommandUse it for
coven wtCreate, list, diagnose, and prune Coven worktrees.
coven claimManage TTL-bounded agent branch claims.
coven maintenanceFence new Coven writers while maintenance drains existing writers.
coven hooks installInstall Coven Parallel Work Protocol git hooks.
coven wardInspect and migrate Ward configuration.
coven adapterList and diagnose harness adapters.

Covered on Repo workflow.

Configuration paths, reset, and color

Inspect path resolution without starting the daemon or creating state:

coven config paths --json

coven reset is preview-only unless --apply is passed. Select one or more registered categories with --feature, inspect them with --list-features, or use --all --apply. Applied resets move selected state to $COVEN_HOME/reset-backups/; they do not delete project directories, contact GitHub, or revoke provider credentials. Windows currently supports preview, not --apply.

Every command accepts the global --color auto|always|never option. auto honors NO_COLOR and CLICOLOR_FORCE.

What owns what

The CLI is a client and presentation layer. The daemon is the authority boundary for launches, cwd validation, session liveness, input forwarding, kill requests, and stored event state.

Use these references together:

Bare prompt shortcut

When you pass text without a subcommand, Coven treats it as a Cast prompt:

coven "explain this repo in 5 bullets"

Use the shortcut for quick interactive work. Use coven run <harness> <prompt> when you want an explicit harness and session record.

Was this page helpful?No

Last updated on

On this page