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
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 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
say-hello-workflowran one job called say-hello.
- Spin up environment
- Preparing environment variables
- Checkout code
- Say hello
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.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
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.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.