search

CircleCI-Public / circleci-cli-orb

Easily install and use the CircleCI CLI, on CircleCI
https://circleci.com/orbs/registry/orb/circleci/circleci-cli
MIT License
2 stars 8 forks source link
circleci circleci-cli circleci-orbs

readme

CircleCI CLI Orb CircleCI Build Status CircleCI Orb Version GitHub license CircleCI Community

Quickly and easily install and configure the CircleCI command-line interface (CLI), on CircleCI, for running "local" jobs and interacting with CircleCI configuration, orbs, and CircleCI's GraphQL API.

Usage

For full usage guidelines, see the orb registry listing.

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.1

jobs:
  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.z

workflows:
  cli-orb-example:
    jobs:
      - use-executor
      - use-install-command

Contributing

We welcome issues to and pull requests against this repository!

For further questions/comments about this or other orbs, visit CircleCI's orbs discussion forum.