Skip to main content

Build & Manage Workflows

Create and orchestrate AI workflows with intuitive commands. Test your implementations locally and deploy them with confidence.

Publish Components

Build reusable components like custom tools, agents, and tasks. Share them with your team or the Compozy community through our registry.

Handle Dependencies

Easily integrate pre-built components from our curated registry. Manage versions and dependencies with simple commands.

Local Development

Rapid development with hot-reload capabilities. Debug workflows in real-time and iterate quickly on your implementations.

Cloud Deployment

Deploy your workflows to Compozy Cloud for scalable production use, or to your own infrastructure for complete control.

​
Installation

Install the Compozy CLI using your preferred package manager. We support multiple installation methods to fit your development environment: 
# Using npm (recommended for Node.js users)
npm install -g @compozy/cli

# Using pnpm (faster, more efficient installation)
pnpm add -g @compozy/cli

# Using bun (fastest JavaScript runtime)
bun install -g @compozy/cli

​
Basic Usage

The Compozy CLI provides several categories of commands:

​
CLI Categories

Project Management

Initialize, configure, and manage Compozy projects. Set up environments and project structure.

Dependency Management

Add, remove, and update project dependencies. Manage component versions and compatibility.

Development Tools

Local development server, debugging tools, and testing utilities for rapid iteration.

Component Development

Create, test, and maintain custom components. Build reusable workflow elements.

Registry Commands

Publish and manage components in the Compozy Registry. Share and discover reusable workflow elements.

Deployment

Deploy workflows to production environments. Manage deployments and infrastructure settings.

​
Getting Help