Reference
Admin CLI
The circi server command and its admin subcommands, run on the server.
The circi command inside the Docker image is the server command. It reads the same environment variables as the server (it needs DATABASE_URL and the storage settings for most commands), so run it in the container:
docker compose exec circi circi admin doctorIt's not the upload CLI (see CLI reference). Commands that act inside a workspace take --org <slug>; the flag keeps its name from when workspaces were called organizations. Expected failures print one line and exit 1. --debug (or DEBUG=1) prints a stack trace.
Processes
Section titled “Processes”| Command | What it does |
|---|---|
circi all |
HTTP server and worker in one process (small installs). |
circi serve |
The HTTP API and web UI. |
circi worker |
Background jobs (diffing, notifications). |
circi migrate |
Apply database migrations and exit. |
serve, worker and all migrate on start unless --no-migrate.
circi admin …
Section titled “circi admin …”Every command starts with circi admin. Add --help to any of them.
Accounts and workspaces
Section titled “Accounts and workspaces”| Command | What it does |
|---|---|
user create --email --name [--password] [--instance-admin] [--json] |
Create an account. There's no self sign-up. The password needs at least 12 characters; without --password one is generated and printed once. |
user set-password --email [--password] [--json] |
Set a new password. |
workspace create --name --owner <email> [--slug] [--json] |
Create a workspace owned by an existing account. |
workspace list [--json] |
List workspaces. |
member add --org --email [--role owner|admin|member] |
Add an existing account to a workspace (default role member). |
auth enable|disable <email|password> --org |
Change a workspace's allowed sign-in methods. Skips the check that refuses a change leaving nobody able to sign in, so it's the way back in when a setting locked everyone out. |
Projects
Section titled “Projects”| Command | What it does |
|---|---|
project create --org --name [--slug] [--default-branch main] [--member <email>…] [--json] |
Create a project and print its CI token. |
project list --org [--json] |
List a workspace's projects. |
project rotate-token --org --project [--json] |
Replace the CI token; the old one stops at once. |
ignore add --org --project --name <screenshot> --region <x,y,width,height> |
Ignore a rectangle (pixels from the top left) in screenshots with that name. |
ignore list --org --project |
List ignored regions. |
ignore remove <id> --org --project |
Stop ignoring a region. |
Integrations
Section titled “Integrations”| Command | What it does |
|---|---|
github link --org --project --repo <owner/name> --installation <id> |
Link a project to a GitHub repository (needs the GitHub App). |
github unlink --org --project |
Stop reporting a project to GitHub. |
webhook add --org --project --url --events <list> [--json] |
Add a webhook; the signing secret is printed once. Events: build.completed, build.reviewed. At least one is required. |
webhook list --org --project |
List a project's webhooks. |
webhook remove --org --project --id |
Remove one (ID from list). |
Storage
Section titled “Storage”| Command | What it does |
|---|---|
storage usage [--json] |
Files and bytes by kind, and what waits to be deleted. |
storage migrate --to fs|s3 [--path] [--bucket] [--region] [--endpoint] [--force-path-style] |
Copy every stored file to another storage under the same keys. |
storage gc [--grace-hours <h>] [--dry-run] |
Run retention now. |
Checks and setup
Section titled “Checks and setup”| Command | What it does |
|---|---|
doctor |
Check storage, database and migrations, mail, free disk space, the dashboard address and the cookie scope of the domains. Exits 1 on a warning or failure. |
setup-code |
Print the code the first-run setup page asks for. |
mail test --to <email> |
Send a test mail through the configured SMTP server. |