Linux command
circleci 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Configure CLI with API token
circleci setup
Validate config file
circleci config validate
Run job locally
circleci local execute --job [build]
Process config file
circleci config process [.circleci/config.yml]
Create new project
circleci project create
List orbs
circleci orb list
Follow a project
circleci follow
Open CircleCI in browser
circleci open
说明
circleci is the official CLI for CircleCI, enabling local job execution, config validation, pipeline management, and interaction with CircleCI resources from the terminal. The CLI is particularly useful for validating and processing configuration files before pushing changes, running jobs locally in Docker containers for faster development iteration, and managing orbs, contexts, and project settings. It integrates with the CircleCI API for pipeline and workflow management. Local execution requires Docker and runs individual jobs in containers that mirror the cloud environment, though some features like caching and workflows are not available locally.
参数
- --token _token_
- CircleCI API token
- --host _url_
- CircleCI host URL
- --debug
- Enable debug output
- --skip-update-check
- Skip update check
FAQ
What is the circleci command used for?
circleci is the official CLI for CircleCI, enabling local job execution, config validation, pipeline management, and interaction with CircleCI resources from the terminal. The CLI is particularly useful for validating and processing configuration files before pushing changes, running jobs locally in Docker containers for faster development iteration, and managing orbs, contexts, and project settings. It integrates with the CircleCI API for pipeline and workflow management. Local execution requires Docker and runs individual jobs in containers that mirror the cloud environment, though some features like caching and workflows are not available locally.
How do I run a basic circleci example?
Run `circleci setup` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --token _token_ do in circleci?
CircleCI API token