Quickstart guide

1 week ago3 min read
Last updated • Read time
Cloud
This document is applicable to CircleCI Cloud

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.

Prerequisites

  • 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.



1. Create a project
In the CircleCI web app, select Projects from the sidebar. Click Create Project, then select the repository you would like to connect from the dropdown. Don’t see these options? Use the org selector in the top left corner to find the correct organization.
Select Projects
2. Generate config
Give your project a name, check the options, then click Create Project. A config.yml file is generated for you based on the languages and frameworks used in your project.
Config Editor
3. Commit and run your config
Click Commit and Run. This will create a .circleci/config.yml file at the root of your repository on a new branch called circleci-project-setup. At this point you can also choose Review configuration file if you would rather check or make changes to the config file before committing.
Commit a config
4. Congratulations 🎉
You should soon have a passing pipeline. If you are happy with this configuration, merge it into your main branch, or continue to make changes.
Passing pipeline

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?
Select 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
Select 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