Start Building for Free

Quickstart guide

3 months ago3 min read
On This Page

This quickstart guide takes you through connecting an existing project to CircleCI, using the in-app config editor, and inviting team members to collaborate on your new project.

If you would rather jump to a full list of CircleCI config.yml options, see the Configuration reference.


  • A CircleCI account connected to your code. You can sign up for free.

  • A code repository you want to build on CircleCI.

1. Connect your code

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

Check your account type

GitHub authorization with CircleCI is changing. To find out if you authorized through the GitHub OAuth app or the CircleCI GitHub App, see the GitHub App integration page.

2. Dig into your first pipeline

header banner
Explore your passing pipeline and invite your teammates to join you, for free. By collaborating, you can troubleshoot, get pull requests approved, and build and test faster.

1. So, what just happened?
Click on the green Success button to see details about a workflow. The workflow expands to show all jobs that ran.
Green Success Button
2. View your results
Click on a job to enter the job view and see all the steps that ran.
Steps in Pipeline Job
3. Collaborate with teammates
Collaborators can 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. Invite team members using the Add team members link next to your project name on the dashboard. If you do not see this option, ensure you have a project selected.
Add Team Members

Suggest an edit to this page

Make a contribution
Learn how to contribute