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

Using the CircleCI VS Code extension

• If you use VS Code and install the CircleCI extension, your configuration will be continuously validated as you make changes in the editor.
• Warnings and error counts will appear in the Status Bar and with validation details appearing in the problems panel.

Additional Resources

• Installing the CircleCI Local CLI
• Get started with the VS Code extension