Run a pipeline configuration. When a local config is supplied, it runs it via a ci pipeline in circleci’s cloud.
Run a pipeline configuration. When a local config is supplied, it runs it via a ci pipeline in circleci’s cloud.
Required arguments: orgSlug The second segment of the slash-separated project slug, as shown in Project Settings > Overview. For example, in circleci/6phtklsjdlskE/cLKSdlksdn it would be 6phtklsjdlskE
project-id Project ID (e.g. 44n9wujWcTnVZ2b5S8Fnat). You can view it in Project Settings > Overview.
–pipeline-definition-id The unique id for the pipeline definition. This can be found in the page Project Settings > Pipelines.
Optional flags: # Note for config-* and checkout-: Both required if running a pipeline run without a local config file. If you are using a local config file, you can omit the config- flags. # Note for –local-config-file: If you want to run a pipeline with a local config file, you need to enable “Allow triggering pipelines with unversioned config” in Organization Settings > Advanced. –config-branch Branch to use for config (mutually exclusive with –config-tag) –config-tag Tag to use for config (mutually exclusive with –config-branch) –checkout-branch Branch to checkout (mutually exclusive with –checkout-tag) –checkout-tag Tag to checkout (mutually exclusive with –checkout-branch) –local-config-file Path to a local config file to use –parameters Pipeline parameters in key=value format (can be specified multiple times) –repo-config Use repository config
Examples: # Minimal usage (will prompt for required values): circleci pipeline run 6phtklsjdlskE 44n9wujWcTnVZ2b5S8Fnat
# Full usage with all flags: circleci pipeline run 6phtklsjdlskE 44n9wujWcTnVZ2b5S8Fnat –pipeline-definition-id abc123
–config-branch main –checkout-branch feature-branch –local-config-file .circleci/config.yml “–parameters”, “key1=value1”, “–parameters”, “key2=value2”
circleci pipeline run <orgSlug> <project-id> --pipeline-definition-id <id> [options...] [flags] --checkout-branch string Branch to checkout (mutually exclusive with --checkout-tag)
--checkout-tag string Tag to checkout (mutually exclusive with --checkout-branch)
--config-branch string Branch to use for config (mutually exclusive with --config-tag)
--config-tag string Tag to use for config (mutually exclusive with --config-branch)
-h, --help help for run
--local-config-file string Path to a local config file to use
--parameters stringToString Pipeline parameters in key=value format (can be specified multiple times) (default [])
--pipeline-definition-id string Pipeline definition ID to test
--repo-config Use repository config --host string URL to your CircleCI host, also CIRCLECI_CLI_HOST (default "https://circleci.com")
--skip-update-check Skip the check for updates check run before every command. (default true)
--token string your token for using CircleCI, also CIRCLECI_CLI_TOKEN