https://github.com/circleci-public/circleci-cli-orb
Easily install and use the CircleCI CLI, on CircleCI
https://github.com/circleci-public/circleci-cli-orb
circleci circleci-cli circleci-orbs
Last synced: 6 months ago
JSON representation
Easily install and use the CircleCI CLI, on CircleCI
- Host: GitHub
- URL: https://github.com/circleci-public/circleci-cli-orb
- Owner: CircleCI-Public
- License: mit
- Created: 2019-05-30T20:57:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T16:39:43.000Z (about 2 years ago)
- Last Synced: 2025-03-27T07:35:48.104Z (6 months ago)
- Topics: circleci, circleci-cli, circleci-orbs
- Language: Shell
- Homepage: https://circleci.com/orbs/registry/orb/circleci/circleci-cli
- Size: 32.2 KB
- Stars: 2
- Watchers: 11
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CircleCI CLI Orb [](https://circleci.com/gh/CircleCI-Public/circleci-cli-orb) [](https://circleci.com/orbs/registry/orb/circleci/circleci-cli) [](https://raw.githubusercontent.com/CircleCI-Public/circleci-cli-orb/master/LICENSE) [](https://discuss.circleci.com/c/ecosystem/orbs)
Quickly and easily install and configure the [CircleCI command-line interface](https://circleci-public.github.io/circleci-cli/) (CLI), on CircleCI, for [running "local" jobs](https://circleci.com/docs/2.0/local-cli/#run-a-job-in-a-container-on-your-machine) and interacting with CircleCI configuration, orbs, and CircleCI's GraphQL API.
## Usage
_For full usage guidelines, see the [orb registry listing](https://circleci.com/orbs/registry/orb/circleci/circleci-cli)._
## Examples
### executor-command-example
Run a job inside the CircleCI CLI container, via this orb's executor. In another job, use the orb to install the CLI.```
version: 2.1jobs:
use-executor:
executor: cli/default
steps:
- run: echo "this job is using the orb's default executor"
use-install-command:
docker:
- image: 'circleci/circleci-cli:latest'
steps:
- cli/install
- run: echo "the CLI is now installed"
orbs:
cli: circleci/circleci-cli@x.y.zworkflows:
cli-orb-example:
jobs:
- use-executor
- use-install-command
```## Contributing
We welcome [issues](https://github.com/CircleCI-Public/circleci-cli-orb/issues) to and [pull requests](https://github.com/CircleCI-Public/circleci-cli-orb/pulls) against this repository!
For further questions/comments about this or other orbs, visit [CircleCI's orbs discussion forum](https://discuss.circleci.com/c/ecosystem/orbs).