The Compozy CLI provides essential commands for managing your AI workflow projects. For detailed CLI features and commands, see our CLI Overview.

​
Quick Installation

Install the Compozy CLI using your preferred package manager:

# Using npm (recommended for Node.js users)
npm install -g @compozy/cli

​
Project Configuration

Every Compozy project uses a compozy.yaml configuration file to define its structure, dependencies, and settings. For detailed configuration options and examples, see our Project Configuration Guide.

​
Development Workflow

Initialize a Project

Create a new Compozy project:

compozy init my-project

Configure Settings

Edit your compozy.yaml to set up dependencies and configurations. See our Configuration Guide for details.

Development

Start the development server for local testing:

compozy dev

Deploy

Deploy your project to production:

compozy deploy

For deployment options, check our Deployment Guide.

​
Need Help?