Quickstart guide
1 month ago
This quickstart provides a guided tour through setting up a project, collaborating, and tools to iterate on and debug your build configuration. The following sections cover the following:
-
Create a project, connecting some existing code to CircleCI.
-
Inviting team members to collaborate on your new project.
-
Use the VS Code extension to debug and extend your config.
-
SSH into a build to debug your project.
If you would rather jump to a full list of CircleCI config.yml options, see the Configuration reference.
Prerequisites
-
A CircleCI account. You can sign up for free.
-
A code repository you want to build on CircleCI.
| This guide assumes you have signed up and connected to GitHub, Bitbucket or GitLab |
Check your project slug to discover which GitHub integration you have set up:
-
Head to the CircleCI web app and select your org from the cards on your user homepage.
-
Select Projects from the sidebar and locate your project from the list. You can use the search to help.
-
Select the ellipsis menu
next to your project and select Project Settings. The project slug is listed on the project settings homepage.-
GitHub App: Project slug starts with
circlecifollowed by UUIDs. For example,circleci/34R3kN5RtfEE7v4sa4nWAU/4nYdoKGkb6RXn7JGt8SQtg). -
GitHub OAuth app: Project slug is human readable. For example,
github/circleci/circleci-demo-workflows.
-
For more information about the differences, see the VCS integration overview.
1. Connect your code
Create a project, connect your new code repository, and commit a CircleCI configuration file. View your project build in the CircleCI app.
-
GitHub App
-
GitLab & Bitbucket Data Center
-
GitHub OAuth app & Bitbucket Cloud
Create a project
In the CircleCI web app select your org, then select Create project, then follow the instructions in the app.
If you do not see these options select the CircleCI logo in the top bar to get back to your user homepage and check you have the correct org selected.
Set up a pipeline
Follow the in-app instructions to set up your pipelinem including connecting your code, preparing a config file and reviewing triggers.
For a more detailed look at this process see the Create a project guide.
Commit and run
Once you have gone through the pipeline setup process in the app you have everything you need to commit your config (unless you have a config in your repo already) and build.
Review your project details and select Commit config and run.
Congratulations 🎉
You should soon have a passing pipeline.
In the next sections we will cover ways to modify and debug your config.
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.
If you do not see the org selector in the top left corner to find the correct organization.
Select a config.yml
In the “Select your config.yml file” modal, select Fast, then give your project a name, and select Create Project. If you are authenticated through the GitHub App, you also need to set up SSH access for your project at this point.
CircleCI config editor
You are now in the <a class="no-external-icon" CircleCI config editor, pre-populated with a sample config.yml file. You can swap out this config for an alternative by selecting Change: Hello World.
Commit 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 update-circleci-config.
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.
Set up a project
In the CircleCI web app select your org, then select Set up a Project, then select Set up Project next to your project in the list.
If you do not see these options, select the CircleCI logo in the top bar to get back to your user homepage and check you have the correct org selected.
Select a config.yml
In the “Select your config.yml file” modal, select Faster, then click Set Up Project.
Congratulations 🎉
You should soon have a passing pipeline. In the next sections we will cover ways to modify and debug your config.
2. Dig into your first pipeline
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.
So, what just happened?
Expand your workflow and select a job to view the steps that ran. Use the tabs along the top to access test results, timing data, artifacts, and resource usage metrics.
View step output
Expand any step to view the build output. You can search, share or download the output for collaboration and debugging. If a step fails, use the Explain this error button for help.
Invite teammates
Invite teammates to collaborate on your projects. Navigate to Organization Settings > People to generate invites and get further instructions. 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.
3. Debug and iterate
Discover CircleCI features to help debug and configure your builds.
Rerun with SSH
To access a job’s build environment for troubleshooting, rerun the job with SSH access. The VM remains active for 10 minutes after the pipeline finishes. For full details, see the Debug with SSH page.
VS Code extension
Using the CircleCI VS Code extention, validate your CircleCI config file. Get help with troubleshooting config updates and help keeping dependencies up to date.