CLI

The Crow CLI (crow) allows you to interact with Crow CI from the command line. You can manage repositories, pipelines, secrets, and more.

Installation

Binary Download

Download the CLI from the project’s releases page. Choose the appropriate binary for your platform.

Container Image

The CLI is also available as a container image:

docker run --pull always \
  -e CROW_TOKEN=$CROW_TOKEN \
  -e CROW_SERVER=$CROW_SERVER \
  --rm -it codeberg.org/crowci/crow-cli:dev info

Configuration

The CLI requires two environment variables:

Variable	Description
`CROW_SERVER`	URL of your Crow CI server (e.g., `https://ci.example.com`)
`CROW_TOKEN`	Personal access token from the Crow CI web interface

You can generate a token in the Crow CI web interface under Settings > Personal Access Tokens.

Common Commands

Repository Management

# List repositories
crow repo ls

# Show repository info
crow repo info owner/repo

# Sync repositories from forge
crow repo sync

Pipeline Management

# List recent pipelines
crow pipeline ls owner/repo

# Show pipeline details
crow pipeline info owner/repo <pipeline-id>

# Trigger a new pipeline
crow pipeline start owner/repo

# Stop a running pipeline
crow pipeline stop owner/repo <pipeline-id>

Secrets Management

# List secrets
crow secret ls owner/repo

# Add a secret
crow secret add owner/repo --name SECRET_NAME --value "secret-value"

# Remove a secret
crow secret rm owner/repo SECRET_NAME

Local Pipeline Execution

# Run pipeline locally (requires Docker)
crow exec

# Run with specific workflow file
crow exec --workflow .crow/build.yaml

Linting

# Lint pipeline configuration
crow lint .crow/

Agent Management

# List organization agents
crow org agent ls <org-name>

# Add an organization agent
crow org agent add <org-name> --name "my-agent"

# Show agent details
crow org agent show <org-name> --agent-id <agent-id>

# Remove an organization agent
crow org agent rm <org-name> --agent-id <agent-id>

Global Agent Management

Requires admin privileges.

# List all agents (admin only)
crow admin agent ls

# Show agent details (admin only)
crow admin agent show <agent-id>

# Remove an agent (admin only)
crow admin agent rm <agent-id>

User Management

Requires admin privileges.

# List all users
crow admin user ls

# Show user details
crow admin user show <username>

# Add a new user
crow admin user add <username>

# Remove a user
crow admin user rm <username>

Getting Help

# Show all commands
crow --help

# Show help for a specific command
crow repo --help
crow pipeline start --help