Skip to main content

[Server] Install the CircleCI CLI (v0) for CircleCI Server

CircleCI Server does not yet include the APIs and query services that the 1.0 CLI requires. Install the v0 CLI as circleci-v0 (Homebrew, install script, or GitHub release) and point it at your Server host.

The current CircleCI CLI (1.0.x, the binary named circleci) is built for CircleCI Cloud. CircleCI Server does not currently ship the newer APIs and query services that CLI 1.0 requires, so that CLI is not supported against a Server installation.

Use the v0 CLI instead. The supported Server package is 0.1.47860. On macOS and Linux it installs as a separate binary named circleci-v0, so it can sit next to a Cloud 1.0 CLI on the same machine.

What to use when

Product

CLI

Binary

CircleCI Server

v0 (0.1.47860)

circleci-v0

CircleCI Cloud

1.0.x

circleci

Do not run circleci 1.0 against your Server hostname. Do not let Homebrew or the CLI auto-update replace a working v0 install with 1.0 if that is the only CLI you use for Server.

Command reference for v0 is circleci-v0 --help (and nested --help on each subcommand). Official Server CLI docs are still catching up; this article is the install path to share until those pages land.

macOS / Linux — Homebrew (recommended)

Requires Homebrew. This is a cask on CircleCI’s tap:

brew install circleci-public/circleci/circleci@v0

That installs 0.1.47860 as circleci-v0. Homebrew’s caveat is that this binary is meant to run alongside the current circleci (homebrew-core formula or the circleci@next cask).

Confirm:

circleci-v0 version

Expected:

0.1.47860+a631c5b (release)

If you also use Cloud, circleci version can still report 1.0.x. Both binaries can be on PATH at once.

Linux, macOS, or WSL — install script

Pin 0.1.47860. From that version onward the script installs circleci-v0, not circleci. Older 0.1.x builds installed as circleci and would overwrite a 1.0 binary.

curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | VERSION=0.1.47860 bash

If /usr/local/bin is not writable, the script uses sudo. To keep the existing 1.0 circleci binary, do not omit VERSION — an unpinned run installs latest 1.0 as circleci.

Confirm with circleci-v0 version as above.

Windows

There is no Homebrew cask or install.sh path for Windows. Download the Windows zip from the v0.1.47860 GitHub release, extract circleci-v0, and put it on your PATH.

Point the v0 CLI at Server

circleci-v0 setup

When prompted:

  1. Paste a personal API token from your Server UI (User settings → Personal API Tokens), not a Cloud token.

  2. Set the host to your Server URL, for example https://circleci.example.com — not https://circleci.com.

Settings are stored in ~/.circleci/cli.yml. After setup, circleci-v0 diagnostic is a quick check that the CLI can reach that host.

Keep Cloud 1.0 auth (circleci auth login) separate. Use circleci for Cloud and circleci-v0 for Server.

If 1.0 already replaced your old CLI

Typical signs: Homebrew upgraded circleci, or the CLI prompted you to update, and Server commands then fail (missing routes such as API v3, or auth/login that only exists on Cloud).

You do not need to uninstall 1.0 to get Server working again. Install v0 beside it with the Homebrew or pinned-script steps above, then call circleci-v0.

If this machine is Server-only and you want a single CLI, you can still install circleci-v0 and invoke that name. Uninstalling 1.0 is optional (brew uninstall --cask circleci@next or brew uninstall circleci, depending on how 1.0 was installed).

Related

Did this answer your question?