Project Commands
Project commands help you create, configure, and manage Compozy projects. The primary command is `init` for initializing new projects.
Initialize Project
compozy init
Create a new Compozy project with the standard directory structure and configuration files:
# Initialize in current directory
compozy init
# Initialize in a new directory
compozy init my-project
# Initialize with project details
compozy init my-project --name "My AI Workflow" --description "Automated data processing"
# Skip interactive prompts
compozy init my-project --name "My Project" --template basicFeatures
Complete Structure
Creates workflows/, tools/, and agents/ directories with proper organization
Quick Start
Generates example workflow and tool files to get you started immediately
Interactive Setup
Friendly prompts for project configuration with sensible defaults
Documentation
Creates comprehensive README with getting started instructions
Flags
| Flag | Description | Default |
|---|---|---|
--name | Project name (required in non-interactive mode) | - |
--description | Project description | - |
--version | Initial version | 0.1.0 |
--template | Project template | basic |
--author | Author name | - |
--author-url | Author website/URL | - |
--interactive | Force interactive mode even with flags | false |
Interactive Mode
When run without flags or with --interactive, the init command presents a friendly form:
Initialize New Compozy Project
Project Name:
my-awesome-workflow
Description:
AI-powered workflow automation system
Version:
0.1.0
Author:
Jane Developer
Author URL:
https://github.com/janedev
Template:
basic
Press Enter to continue, Tab to navigate, Ctrl+C to quitGenerated Files
The init command creates these essential files:
Converting Existing Project
If you have existing workflows or tools:
# Initialize in current directory
compozy init .
# Move existing files to proper locations
mv *.yaml workflows/
mv *.ts tools/
# Update compozy.yaml with your workflows
# Edit workflow sources in compozy.yaml