Quickstart guide

Cloud

Prerequisites

Sign up for a free CircleCI account
Sign in and connect a VCS 👋
Create a repository for GitHub, Bitbucket, or GitLab

1. Connect your code

Connect your new code repository, commit a CircleCI configuration file to a new branch, view the pipeline, and see it pass.

2. Dig into your first pipeline

You should see your pipeline start to run automatically—and pass!

1. So, what just happened?

Click on the green Success button to see details about the workflow. say-hello-workflow ran one job called say-hello.

2. View your results

Click the say-hello job to see the steps in this job:

Spin up environment
Preparing environment variables
Checkout code
Say hello

3. Collaborate with teammates

It is easy for teammates and collaborators to view and follow your projects. Teammates can make a free CircleCI account at any time to view your pipelines, even if they are not committing any code.

3. What's next

We recommend inviting your teammates to join you, for free. By collaborating, you can troubleshoot, get pull requests approved, and build and test faster. You can also:

1. Break your build

Try editing your config.yml file. On CircleCI, you can edit files directly and then commit them to your VCS. On the Projects page, click the ••• buttons to view your configuration file. Make any change and save it. You should see a new pipeline run and likely fail. This is a primary benefit of CircleCI: identifying failures early.

2. Explore the workflows function

In your Dashboard, click into the say-hello-world workflow. Can you find the four steps that ran? Hint: step 1 is Spin up environment.

A workflow is a set of rules that defines a collection of jobs and their run order. Workflows support complex job orchestration using a simple set of configuration keys to help you quickly resolve failures.

3. SSH into your build

On a failed pipeline, you can SSH directly into your CircleCI jobs and automatically troubleshoot issues. This feature reruns your pipeline and often finds and fixes errors.

That’s a wrap! We hope you’re up and running and more confident using CircleCI. To continue your progress, check out the resources below or ask for help.

Next steps

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.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.