Quickstart guide

today3 min read

Cloud

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

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

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 circleci followed 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.

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.

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.

2. View your results

Select a job to enter the job view and see all the steps that ran.

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.

Next steps

Suggest an edit to this page

Make a contribution

Learn how to contribute

Still need help?

Ask the CircleCI community

Join the research community

Visit our Support site