Quick Start
Scaffold and run your first Culvii workflow. You need a Culvii account and Node.js 22 or later.
Install the CLI
npm install -g @culvii/cli
Create a starter project
Run culvii init and follow the prompts:
culvii init culvii-quickstart
Press Enter to use the default agent-workflow template and OpenAI provider. The CLI creates the project configuration (package.json, tsconfig.json, .gitignore, culvii.yaml) plus a greeting agent and workflow under src/. Passing --skill or running culvii skill install installs the Culvii authoring skill bundle for AI coding agents.
Install the generated project's dependencies:
cd culvii-quickstart
npm install
Open src/greeter-agent.culvii.ts, then replace:
YOUR_CREDENTIAL_IDwith a credential ID fromculvii integration listor Culvii Console.YOUR_MODEL_IDwith the OpenAI model ID you want to use.
Run it in dev
Log in, then start the development session:
culvii login
culvii whoami
culvii dev
culvii whoami verifies the account and active Culvii context before the dev session starts.
Open the Console URL printed by the CLI, select greeting-workflow, and click Run. Saved changes sync to the dev environment while culvii dev is running.
Deploy to sandbox
When the workflow behaves as expected, deploy it to an existing sandbox workspace. Copy the workspace slug from Culvii Console and use it in place of <workspace-slug>:
culvii deploy --env sandbox --workspace-slug <workspace-slug>
Review the plan and confirm it.