circleci-public / circleci-cli-orb

Easily install and use the CircleCI CLI, on CircleCI

CircleCI CLI Orb

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/[email protected]

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.

circleci-cli-orb's Issues

Version parameter on install job does nothing

Orb version

0.1.9 and older

What happened

Specify an explicit version to install in the install job

  - circleci-cli/install:
      version: v0.1.15224

The job outputs that you want to install version v0.1.15224, but doesn't actually reference it in the install command. It just installs the latest

Selected version of CircleCI CLI is v0.1.15224
A different version of the CircleCI CLI is installed (Build Agent version: 1.0.72666-eaa68b41
Built: 2021-06-14T14:18:26+0000); updating it
Starting installation.
Installing CircleCI CLI v0.1.15338
Installing to /usr/local/bin
/usr/local/bin/circleci
CircleCI CLI version 0.1.15338+850f9ac (release) has been installed to /usr/local/bin/circleci

Expected behavior

When you specify a version for the install job, it should install that version.

circleci-cli/install doesn't install the circleci tool

Orb version

0.1.9

What happened

The src/scripts/install.sh script simply doesn't install the CLI tool if it's missing.
It only does things if it already exists:

• either the installed version is the version we want, and it does nothing
• either it install a different version

But it expects the CLI tool to be already present, which seems wrong.

Expected behavior

If circleci is not available, I would expect it to install the tool with the provided version

Default executor doesn't exit after receiving an exit code 0

Orb version

1.0.0

What happened

I was using this orb's "default" executor and when I switched to use v1.0.0 from v0.1.22 of this orb my job just kept running without completing after receiving an exit code 0.

This message was also in the output:
WARNING: terminal is not fully functional

Expected behavior

The job should have exited after receiving an exit code 0.

Remove reliance on the GitHub API

The install command relies on the GitHub API in order to do it's thing. This is starting to cause of issues with rate limiting since we're unauthenticated.

This orb is occasionally having the same issue as the jq orb: CircleCI-Public/jq-orb#10

circleci reports the image used here as deprecated

Orb version

0.1.9

What happened

Using a configuration that looks like the following:

orbs:
  cli: circleci/[email protected]

jobs:
  validate_orbs:
    executor: cli/default
    steps:
      - checkout
...

I get this error message in the circleci's own app:

Expected behavior

No deprecation messages, obviously :) Please, consider upgrading to cimg/base or adding a new base image with circleci-cli installed