Using the CircleCI In-app Configuration Editor
A UI environment, the CircleCI config editor, is provided for users who wish to modify their configurations without the use of the CircleCI CLI and/or a text editor. Using the CircleCI configuration editor eases the developer experience by giving users the ability to modify their CI/CD processes in a more unified fashion.
The benefits of using the CircleCI config editor include:
- Automatic validation and error checking
- Auto-completion suggestions and configuration tooltips specific to CircleCI configuration syntax
- Education of CircleCI concepts
- Easily accessible CircleCI documentation, designed to best suit your needs
Getting started with the CircleCI config editor
In the CircleCI app, select a pipeline in the All Pipelines view.
To access the CircleCI Configuration Editor, select your desired branch from the All Branches drop-down menu near the top of the screen.
Once you select a branch, the Edit Config button will become enabled. Click it to access the configuration editor.
You can also access the config editor:
- Upon selecting the Set Up Project button in the Projects view
- By selecting the 3 dots in the Actions column in the Pipelines view, then selecting Configuration File from the modal
- By selecting a job in the Pipelines view, selecting the 3 dots in the upper-right corner, and then selecting Configuration File
Like many traditional IDEs, the CircleCI configuration editor will provide auto-complete suggestions as you type, as well as any supporting documentation.
When hovering over a CircleCI definition in your configuration file, a tooltip will appear, giving you additional information specific to CircleCI configuration syntax.
The config editor will automatically validate your configuration yaml after every change.
For a valid configuration, you will see the following at the bottom of the configuration editor:
For a failing validation, a red bar is displayed, as well as any errors, where they occur, and any relevant documentation that may assist in fixing the error (see the “DOCS” tab in the below screenshot).
Commit and run
Once your configuration is valid, you may commit to your VCS and re-run the pipeline, all from within the Config Editor, by selecting the Commit and Run button in the upper-right corner.
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.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.