Docs
Start Building for Free
CircleCI.comAcademyBlogCommunitySupport

Quickstart guide

1 month ago2 min read
Cloud
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.

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.



Check your account type

The authorization method used to set up your CircleCI account determines the definition of "project" in CircleCI, as well as the permissions management processes available to you:

  • If you authenticated using the GitHub OAuth app, or Bitbucket, a "project" in CircleCI maps directly to a "repository" in GitHub. Follow steps to Set up a project below.

  • If you authenticated through GitLab or the CircleCI GitHub App, a "project" within CircleCI is a standalone entity that you create and then associate with a code repository. Follow steps to Create a Project below.

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 the workflow. say-hello-workflow ran one job called say-hello.
Green Success Button
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
Steps in Pipeline Job
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.
Add Team Members

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.

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.

Creative Commons License

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