Hello World

Tutorials & Sample Apps > Hello World

This document describes how to configure your project to run on CircleCI 2.0.


  • If this will be your very first CircleCI project, complete the steps in the Sign Up & Try CircleCI document.


  1. Create a directory called .circleci in the root directory of your local GitHub or Bitbucket code repository.

  2. Create a config.yml file in the .circleci directory with the following lines, replacing <language>:<version TAG> with your programming language and version number. See the CircleCI Images doc for a complete list of languages and versions.

version: 2
      - image: circleci/<language>:<version TAG>
      - checkout
      - run: echo "hello world"

The first image listed defines the execution environment for your job. The primary container, where your job’s commands are run, is created from this image. The steps check out the code in the project directory and run the echo command.

  1. Commit and push the changes. If you were already using CircleCI 1.0, a build is triggered on 2.0, and a 2.0 icon appears on the Job page. First Green Build Screenshot

  2. If this is your first project on CircleCI, go to the Projects page, click the Add Projects button and then click the Build Project button next to your project.

Note: If you do not see your project and it is not currently building on CircleCI, check your org in the top left corner of the CircleCI application. For example, if the top left shows your user myUser, only Github projects belonging to myUser will be available under Add Projects. If you want to build the Github project myOrg/orgProject, you must select myOrg on the application Switch Organization menu.

Switch Organization Menu

CircleCI checks out your code, prints “Hello World”, and posts a green build to the Job page, adding a green checkmark on your commit in GitHub or Bitbucket! If the job fails, you are notified in email of the failure with a log of the failing command, exit code, and output with a red X on the commit in GitHub or Bitbucket.

You automatically follow any new project that you push to, subscribing you to email notifications and adding the project to your dashboard. You can also manually follow or stop following a project by selecting your org on the Projects page in the CircleCI app, clicking the Add Projects button, and then clicking the button next to the project you want to follow or stop following.

Next Steps

See the Concepts document for a summary of 2.0 configuration and the hierarchy of top-level keys in a .circleci/config.yml file.

Refer to the Workflows document for examples of orchestrating job runs with parallel, sequential, scheduled, and manual approval workflows.

Find complete reference information for all keys and pre-built images in the Configuring CircleCI and CircleCI Images documentation.