circleci pipeline run selects a definition by name
Introduced 2026-10-28 · score 0.95
HOW TO USE IT
When starting a pipeline run by definition name, pass `--definition <name>` to `circleci pipeline run`. Use the project slug if git remote detection is unavailable, and do not combine it with `--definition-id`.
circleci pipeline run --project <project-slug> --definition <name>WHY THIS HELPS
When starting a pipeline run and you know the definition's name rather than its ID, select that definition by name.
BEFORE THIS CHANGE
Select a pipeline definition using `--definition-id`.
REQUIREMENTS AND LIMITATIONS
- Version: v1.12.0
- Non-interactive: Omitting `--definition-id` prompts interactively; `--json` outputs JSON.
- --definition <name>: Pipeline definition name; mutually exclusive with `--definition-id`.
- --project <project-slug>: Project slug; defaults to git remote.
- Name matching is case-insensitive and client-side; the server does not filter by name.
- If no definition matches, the command exits 5 and lists available definitions.
- If several definitions match, the command exits 2 and lists the matches.
- `--definition` and `--definition-id` are mutually exclusive.
- `project trigger list/create` continue to take only `--pipeline-definition-id`.
FIRST-PARTY EVIDENCE
- https://github.com/CircleCI-Public/circleci-cli/releases/tag/v1.12.0
- https://github.com/CircleCI-Public/circleci-cli/pull/1948
- https://github.com/CircleCI-Public/circleci-cli/blob/v1.12.0/internal/cmd/root/testdata/help/circleci/pipeline/run.txt
Check the installed version and the source before using it. Entry JSON