Hello world
This page shows you how to get started with a basic pipeline using any execution environment. The steps described here assume you want to create a new project locally and push your changes to your VCS using Git. This page also assumes you have already signed up for CircleCI.
As an alternative, if you already have a repository you want to "plug in" to CircleCI you can set this up entirely within the CircleCI web app, including commiting a config file. This flow is outlined in the Quickstart guide.
Echo hello world
This example adds a job called hello-job
that simply prints hello world
to the console. To get started, complete the following steps:
-
Create a directory called
.circleci
in the root directory of your local code repository. -
From the
.circleci
directory you just created, create aconfig.yml
file and add the following content (select your execution environment using the tabs): -
Commit and push the changes to your VCS.
-
Go to the Projects page in the CircleCI web app, then click the Set Up Project button next to your new project. If you do not see your project, make sure you have selected the correct organization at the top-left of the web app. See the Organization Switching for more information.
-
Follow the steps in the pop-up to tell CircleCI to use the
config.yml
file you just created to trigger your first pipeline. Clicking through to thehello-job
and then selecting theecho "hello world" step
will show youhello world
in the console.
Tip: If you get a No Config Found
error, it may be that you used .yaml
file extension. Be sure to use .yml
file extension to resolve this error.
Echo hello world on server v4.x
This example adds a job called hello-job
that simply prints hello world
to the console. To get started, complete the following steps:
-
Create a directory called
.circleci
in the root directory of your local code repository. -
From the
.circleci
directory you just created, create aconfig.yml
file and add the following content (select your execution environment using the tabs): -
Commit and push the changes to your VCS.
-
Go to the Projects page in the CircleCI web app, then click the Set Up Project button next to your new project. If you do not see your project, make sure you have selected the correct organization at the top-left of the web app. See the Organization Switching for more information.
-
Follow the steps in the pop-up to tell CircleCI to use the
config.yml
file you just created to trigger your first pipeline. Clicking through to thehello-job
and then selecting theecho "hello world" step
will show youhello world
in the console.
Tip: If you get a No Config Found
error, it may be that you used .yaml
file extension. Be sure to use .yml
file extension to resolve this error.
Echo hello world on server v3.x
This example adds a job called hello-job
that simply prints hello world
to the console. To get started, complete the following steps:
-
Create a directory called
.circleci
in the root directory of your local code repository. -
From the
.circleci
directory you just created, create aconfig.yml
file and add the following content (select your execution environment using the tabs): -
Commit and push the changes to your VCS.
-
Go to the Projects page in the CircleCI web app, then click the Set Up Project button next to your new project. If you do not see your project, make sure you have selected the correct organization at the top-left of the web app. See the Organization Switching for more information.
-
Follow the steps in the pop-up to tell CircleCI to use the
config.yml
file you just created to trigger your first pipeline. Clicking through to thehello-job
and then selecting theecho "hello world" step
will show youhello world
in the console.
Tip: If you get a No Config Found
error, it may be that you used .yaml
file extension. Be sure to use .yml
file extension to resolve this error.
Echo hello world on server v2.x
This example adds a job called hello-job
that simply prints hello world
to the console. To get started, complete the following steps:
-
Create a directory called
.circleci
in the root directory of your local code repository. -
From the
.circleci
directory you just created, create aconfig.yml
file and add the following content (select your execution environment using the tabs): -
Commit and push the changes to your VCS.
-
Go to the Add Projects page in the CircleCI web app, then click the Start Building button. If you do not see your project, make sure you have selected the correct organization at the top-left of the web app. See the Organization Switching for more information. You will then see your job and workflow in the relevant pages in the app
Tip: If you get a No Config Found
error, it may be that you used .yaml
file extension. Be sure to use .yml
file extension to resolve this error.
Next steps
-
See the Concepts page for a summary of CircleCI-specific concepts.
-
Refer to the Workflows page for examples of orchestrating job runs with concurrent, sequential, scheduled, and manual approval workflows.
-
Find complete reference information for all keys and execution environments in the CircleCI Configuration Reference.
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.
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.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.