# CircleCI

CI/CD on CircleCI — pipelines, workflows, jobs, test results, insights, project settings, contexts, and schedules.

Run these through `omni-cli` once a human has connected the platform (`omni-cli circleci login`). Full parameter and output schemas come from `omni-cli discovery circleci`.

## checkout keys

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci checkout-key create` | Create a checkout key for a project — each call generates a new key pair. | write |
| `omni-cli circleci checkout-key list` | List a project's checkout keys — the SSH keys its jobs use to check out code. | read |

## discovery

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci collaboration list` | List the organizations your account belongs to (discovers the owner id contexts are scoped to). | read |

## contexts

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci context create` | Create a context in an organization. | write |
| `omni-cli circleci context delete` | Delete a context and every environment variable stored in it. | write |
| `omni-cli circleci context delete-env-var` | Delete an environment variable from a context. | write |
| `omni-cli circleci context get` | Get one context by id. | read |
| `omni-cli circleci context list` | List an organization's contexts — shared secret groups workflows can use (discovers context ids). | read |
| `omni-cli circleci context list-env-vars` | List the environment variables stored in a context — names only, values stay secret. | read |
| `omni-cli circleci context set-env-var` | Set an environment variable in a context — creates the name or replaces its stored value. | write |

## env vars

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci env-var create` | Set a project environment variable — adding a name that already exists replaces its stored value. | write |
| `omni-cli circleci env-var delete` | Delete a project environment variable. | write |
| `omni-cli circleci env-var list` | List a project's environment variables — names with masked values. | read |

## jobs

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci job cancel` | Cancel a running job — repeating the cancel converges on the same stopped state. | write |
| `omni-cli circleci job get` | Get one job by number — status, timing, executor, and the workflow it ran in. | read |
| `omni-cli circleci job list-artifacts` | List the artifacts a job produced, with their download URLs. | read |
| `omni-cli circleci job list-tests` | List the test results a job uploaded — name, result, timing, and failure message per test. | read |
| `omni-cli circleci workflow list-jobs` | List the jobs of a workflow (discovers job numbers). | read |

## pipelines

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci pipeline get` | Get one pipeline by id — state, trigger, and source revision. | read |
| `omni-cli circleci pipeline get-config` | Get a pipeline's configuration — the source config and the compiled configuration that actually ran. | read |
| `omni-cli circleci pipeline list` | List recent pipelines of a project, newest first (discovers pipeline ids). | read |
| `omni-cli circleci pipeline trigger` | Trigger a new pipeline on a project — each call starts a new run; follow it with pipeline.get using the returned id. | write |

## workflows

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci pipeline list-workflows` | List the workflows of a pipeline (discovers workflow ids). | read |
| `omni-cli circleci workflow cancel` | Cancel a running workflow — repeating the cancel converges on the same stopped state. | write |
| `omni-cli circleci workflow get` | Get one workflow by id — status, timing, and the pipeline it belongs to. | read |
| `omni-cli circleci workflow rerun` | Rerun a workflow — each call starts a new run, of the whole workflow, from the failed jobs, or of specific jobs. | write |

## projects

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci project get` | Get one project by its slug — ids, organization, and repository details. | read |

## schedules

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci schedule create` | Create a pipeline schedule on a project. | write |
| `omni-cli circleci schedule delete` | Delete a pipeline schedule. | write |
| `omni-cli circleci schedule get` | Get one pipeline schedule by id. | read |
| `omni-cli circleci schedule list` | List a project's pipeline schedules (discovers schedule ids). | read |
| `omni-cli circleci schedule update` | Update a pipeline schedule — only the provided fields change. | write |

## insights

| Command | What it does | Kind |
|---|---|---|
| `omni-cli circleci workflow metrics` | Aggregated workflow metrics for a project — success rate, throughput, duration percentiles, and credit usage per workflow. | read |