How to validate your CircleCI configuration

Fernando

September 22, 2022 16:41

Validate your config file

You can avoid pushing additional commits to test your .circleci/config.yml and confirm that your file is free of syntax errors, YAML linting issues, etc. by using the CircleCI CLI to validate your configuration locally.

Using CircleCI CLI to validate

Visit https://circleci.com/docs/2.0/local-cli and install the CLI
Generating a personal API token and configure the CLI by running circleci setup
Navigate to a directory with a.circleci/config.yml file
Run circleci config validate in your project's root directory

Troubleshooting

Confirm that your configuration file is in the right directory: .circleci/config.yml and you are in the project's root directory
If the error still occurs, please run circleci version and reach out to our support team

Additional Resources

Installing the CircleCI Local CLI

Was this article helpful?

49 out of 89 found this helpful

Comments

0 comments

Article is closed for comments.

Articles in this section