Build and share a custom CodeCheck configuration¶
A configuration is a named set of checks (with their options) that you inspect against. Instead of running a whole published standard, build a configuration that matches exactly what your team cares about — then save it into the project so everyone uses the same rules.
1. Open the configuration manager¶
Checks → Select Checks opens the Manage Configurations window. It lists the built-in standards (MISRA, AUTOSAR, CERT, …) plus any configurations already in your project.
2. Create or copy a configuration¶
- Click New to start from an empty configuration, or
- Select a standard or existing configuration and click Duplicate to start from a copy.
Both open the editor. Give the configuration a name, then use the check list and the tag/filter buttons to include exactly the checks you want. Selecting a check shows its details and any options (thresholds, naming patterns, and so on) you can set. See which coding standard should I check against? for what each standard covers.
3. Save¶
Click Save & Run to save the configuration and inspect immediately, or close the editor to save without running. New configurations are saved into the project's shared area by default, so they travel with the project.
4. Share it with your team¶
You have two ways to share a configuration:
- Shared in the project. A configuration saved to the project's shared area is picked up automatically by anyone who opens the same project (including its checked-in shared folder). This is the simplest way to keep a team on the same rules. Configurations saved to your local area stay private to you.
- Export/import a file. To hand a configuration to a separate project or team, right-click it and
choose
Export Configuration to write a portable
.jsonfile. Others use Import Configuration in the same window to load it into their project.
Run the same configuration in CI
In Manage Configurations, the
API action copies the exact
und codecheck command line for
the selected configuration to your clipboard — handy for scripting or a pipeline. See
run CodeCheck from the command line and
run CodeCheck in CI.
To go beyond the built-in checks, you can add your own — see write a custom check.