Skip to main content

culvii init

Scaffold a new Culvii project with working agent and workflow files.

Synopsis​

culvii init [project-name] [--template <template>] [--provider <provider>] [--skill [agent]] [--here] [-y, --yes]

Description​

Initializes a new Culvii project directory with a package.json, tsconfig.json, .gitignore, culvii.yaml, and starter src/*.culvii.ts source files based on the selected template, and optionally installs the Culvii authoring skill bundle when --skill is passed. If no arguments are provided, it runs interactively (defaulting to my-culvii-project, agent-workflow, and openai).

Refuses to overwrite a non-empty target directory.

Flags​

FlagRequiredDescription
--template-Template to use: agent-only (a single standalone AI agent), agent-workflow (an AI agent triggered by a manual workflow; default), agent-workflow-tool (an agent that invokes a workflow as a callable tool), or multi-agent (a coordinator agent that delegates to a specialist agent).
--provider-Model provider: openai (default), anthropic, gemini, vertexai, or google-vertex.
--skill [agent]-Install the Culvii authoring skill bundle (claude, cursor, windsurf, github, opencode, gemini, kiro, codex, or agents). When passed without an agent name, auto-detects agent directories in the target project and always includes .agents/skills/culvii (falling back to Claude Code and .agents when none exist).
--here-Scaffold into the current directory instead of a named subdirectory.
-y, --yes-Accept all defaults non-interactively.

Examples​

# Interactive initialization
culvii init

# Initialize a specific template non-interactively
culvii init my-project --template multi-agent --provider anthropic -y

# Initialize with a specific skill bundle
culvii init my-project --template agent-workflow --provider anthropic --skill opencode -y

Error behaviour​

ConditionMessageExit
Invalid template"Invalid template '<value>'. Valid options: ..."1
Invalid provider"Invalid provider '<value>'. Valid options: ..."1
Invalid skill agent"Invalid agent: <value>. Must be one of: ..."1
Directory not empty"Directory '<path>' already exists and is not empty."1