> ## Documentation Index
> Fetch the complete documentation index at: https://docs.compozy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Overview

> The Compozy CLI is a powerful command-line interface that enables you to build, test, and deploy AI workflows with ease. Learn how to use its core features to streamline your development process.

<Steps titleSize="h3">
  <Step title="Build & Manage Workflows" icon="code">
    Create and orchestrate AI workflows with intuitive commands. Test your implementations locally and deploy them with confidence.
  </Step>

  <Step title="Publish Components" icon="puzzle-piece">
    Build reusable components like custom tools, agents, and tasks. Share them with your team or the Compozy community through our registry.
  </Step>

  <Step title="Handle Dependencies" icon="box">
    Easily integrate pre-built components from our curated registry. Manage versions and dependencies with simple commands.
  </Step>

  <Step title="Local Development" icon="laptop-code">
    Rapid development with hot-reload capabilities. Debug workflows in real-time and iterate quickly on your implementations.
  </Step>

  <Step title="Cloud Deployment" icon="cloud">
    Deploy your workflows to Compozy Cloud for scalable production use, or to your own infrastructure for complete control.
  </Step>
</Steps>

## Installation

Install the Compozy CLI using your preferred package manager. We support multiple installation methods to fit your development environment:

<CodeGroup>
  ```bash javascript theme={"dark"}
  # 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
  ```

  ```bash brew theme={"dark"}
  # macOS via Homebrew
  brew install compozy
  ```

  ```bash pacman theme={"dark"}
  # Arch Linux and derivatives
  sudo pacman -S compozy-cli
  ```

  ```bash cargo theme={"dark"}
  # Cross-platform installation via Rust
  # Requires Rust toolchain: https://rustup.rs
  cargo install compozy-cli
  ```
</CodeGroup>

## Basic Usage

The Compozy CLI provides several categories of commands:

## CLI Categories

<CardGroup cols={2}>
  <Card title="Project Management" icon="folder" href="/cli/project">
    Initialize, configure, and manage Compozy projects. Set up environments and project structure.
  </Card>

  <Card title="Dependency Management" icon="box" href="/cli/dependencies">
    Add, remove, and update project dependencies. Manage component versions and compatibility.
  </Card>

  <Card title="Development Tools" icon="laptop-code" href="/cli/dev-tools">
    Local development server, debugging tools, and testing utilities for rapid iteration.
  </Card>

  <Card title="Component Development" icon="puzzle-piece" href="/cli/components">
    Create, test, and maintain custom components. Build reusable workflow elements.
  </Card>

  <Card title="Registry Commands" icon="cloud-arrow-up" href="/cli/registry">
    Publish and manage components in the Compozy Registry. Share and discover reusable workflow elements.
  </Card>

  <Card title="Deployment" icon="rocket" href="/deployment">
    Deploy workflows to production environments. Manage deployments and infrastructure settings.
  </Card>
</CardGroup>

## Getting Help

* Run `compozy --help` for detailed command information and examples
* Join our [Discord community](https://discord.gg/compozy) for support and discussions
* Browse our comprehensive [documentation](/core/base-structure/overview)
* Report issues on our [GitHub repository](https://github.com/compozy/cli)