Getting Started with the CircleCI CLI
For those who prefer to spend most of their development time in the terminal, consider installing the CircleCI CLI to interact with your projects on CircleCI. This document provides a step-by-step guide on intializing and working with a CircleCI project primarily from within the terminal. Please note that our server offering only supports a legacy version of the CLI. You can find more information on how to install that here: https://circleci.com/docs/2.0/local-cli/#using-the-cli-on-circleci-server.
- You are using a unix-machine (Mac or Linux): the CircleCI CLI tool is installable on Windows but is currently in beta and not as fully featured as unix installations.
- You have a basic knowledge of CI/CD and the features and concepts of CircleCI’s offerings.
- You have a GitHub account
- You have a CircleCI account.
- You have your terminal open and ready to go.
- Optional: An installation of Github’s
Hubcommand line tool (allowing us to interface with Github from the command line rather than the web UI). Learn how to install Hub.
If some of these prerequisites sound unfamiliar, or you are new to the CircleCI platform, you may want to consider reading our getting started guide or reading our concepts document before proceeding.
Initialize a git repo
Let’s start from the very basics: create a project and initialize a git repository. Refer to the below code block for a list of steps.
cd ~ # navigate to your home directory. mkdir foo_ci # create your project in a folder called "foo_ci" cd foo_ci # change directories into the new foo_ci folder. git init # create a git repository touch README.md # Create a file to put in your repository echo 'Hello World!' >> README.md git add . # Stage every file to commit git commit -m "Initial commit" # create your first commit.
Connect your git repo to a VCS
Great! We have a git repository set up, with one file that says “Hello World!”. We need to connect our local git repository to a Version Control System - either GitHub or BitBucket. Let’s do that now.
If you have installed and setup the Hub CLI, you can simply run:
Then follow any prompts regarding logins / authorizing the HUB CLI.
If you aren’t using Hub, head over to GitHub, login, and create a new respository. Follow the instructions to commit and push to the remote. These instructions generally looks like this:
git remote add origin email@example.com:<YOUR_USERNAME>/foo_ci.git git push --set-upstream origin master
You now have a git repo that is connected to a VCS. The remote on your VCS (“origin”) now matches your local work.
Download and set up the CircleCI CLI
Next, we will install the CircleCI CLI and try out some of its features. To install the CLI on a unix machine run the following command in your terminal:
curl -fLSs https://circle.ci/cli | bash
There are multiple installation methods for the CLI, you can read more about them here if you need to use an alternative method.
Now run the setup step after the installation:
You’ll be asked for your API token. Go to the Account Settings page and click
Create a New Token. Name your token and copy the resulting token string and keep it somewhere safe!
Return to the CLI and paste in your API token to complete your setup.
Setup and validate our first config
Now it’s time to create a configuration file in our project directory.
cd ~/foo_ci # Make sure you are still in the foo_ci folder mkdir .circleci # create a directory called ".circleci" cd .circleci # change directories to the new directory touch config.yml # create an YAML file called "config.yml"
The above commands create a
.circleci folder where we will store our config file.
Open the newly created
config.yml file and paste the following contents into it.
version: 2.0 jobs: build: docker: - image: circleci/ruby:2.4.2-jessie-node auth: username: mydockerhub-user password: $DOCKERHUB_PASSWORD # context / project UI env-var reference steps: - checkout - run: echo "Hello World"
Now let’s validate your config to ensure it’s useable. In the root of your project, run the following command:
circleci config validate
NOTE: if at any time you want to learn more about a command you are using you can append
--help to receive additional information in the terminal about the command:
circleci config validate --help
Testing a job before pushing to a VCS
The CircleCI CLI enables you to test a job locally from the command line rather than having to push to your VCS. If a job in your configuration is proving problematic, this is a great way to try and debug it locally rather than using credits or minutes on the platform.
Try running the “build” job locally:
circleci local execute
This will pull down the docker image you have specified, in this case
circleci/ruby::2.4.2-jessie-node and run the job. This may take a bit of time depending on the size of the docker image you are using.
You should see quite a bit of a text in your terminal. The last few lines of output should look similar to this:
====>> Checkout code #!/bin/bash -eo pipefail mkdir -p /home/circleci/project && cp -r /tmp/_circleci_local_build_repo/. /home/circleci/project ====>> echo "Hello World" #!/bin/bash -eo pipefail echo "Hello World" Hello World Success!
Connect your repo to CircleCI
We will need to leave the terminal behind for this step. Head over to the “Add Projects page”. It’s time to set up your project to run CI whenever you push code.
Find your project (“foo_ci”, or whatever you named it on GitHub) in the list of projects and click “Set Up Project”. Next, return to your terminal and push your latest changes to GitHub (the addition of our
git add . git commit -m "add config.yml file" git push
Returning to CircleCI in your browser, you can now click “start building” to run your build.
This document provides a small overview to getting started with the CircleCI CLI tool. There are several more complex features that the CircleCI CLI offers:
- Creating, viewing, validating and publishing orbs
- Querying the CircleCI GraphQL api
- Packing and Processing complex configuration files.
Consider reading our document covering the CLI for more details.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.