Skip to content

Configuration examples

Jump to bottom
github-actions[bot] edited this page Oct 18, 2026 · 7 revisions

aliases:

  • configuration examples lang: en

Language: English · Русский

The files next to this page are working example configurations stored with the documentation. Revit Linter does not read configurations from the repository: the welcome window installs these same files, or you can copy them by hand.

File Module Contents
config.yaml [[User element diagnostics User diagnostics]]
collision.config.yaml Collision diagnostics Eleven rules: MEP (CLSN1xx) with host-only, linked-model (CLSN104) and connected-run (CLSN105) variants, architecture (CLSN2xx) and structure (CLSN3xx).
parameter-element.config.yaml Project parameter diagnostics One rule per discipline built from the ADSK shared parameter file: PRMTR101, PRMTR201 and PRMTR301.
practical-tour.config.yaml Practical tour The managed TOUR001 check with the visualizations and fix menu required by the guided workflow. It is installed automatically when the tour starts.

The same files with Russian message texts are in the ru subfolder. Formulas reference parameters by BuiltInParameter name, so the rules work in any Revit language.

Discipline blocks

In the collision and project parameter files every discipline is enclosed in a pair of comment lines:

# >>> section: mep — MEP systems
- code: "CLSN101"
  ...
# <<< section: mep

The welcome window keeps only the blocks of the selected disciplines (mep, architecture, structure). When copying by hand, delete the blocks you do not need or leave them all.

What to keep in mind

  • Collisions are searched inside one document; linked models do not take part. A rule selects elements by category and class, so it cannot tell a structural wall from an architectural one. Run a block in the model of its discipline, or narrow it with takeDocument.
  • groupBy is a constant in the examples, so every selected element is compared with every other one. Replace it with a formula to compare elements only inside a group.
  • The project parameter rules use names and GUIDs from the ADSK shared parameter file. The binding type, categories and group are an example of a company standard; adjust them to your template.
  • The project parameter file uses the group format of Revit 2024 and newer. For Revit 2021–2023 replace it with a BuiltInParameterGroup name such as PG_DATA; a rule whose group does not fit the running Revit version is skipped when the file is loaded. The welcome window converts the group automatically. See Project parameter diagnostics.
  • The example rules carry a tags list. Tags are free text: they let you find a rule on the panes and appear in exported reports. Adjust them to your own conventions; a rule without tags has none. The example rules declare Project, because their takeDocument restricts them to project documents.

Working configuration

Revit Linter reads the working YAML files in the configuration folder for the current Revit version. For example, Revit 2025 uses:

C:\Users\{UserName}\Documents\Revit Linter\2025\

The easiest way to open this folder is the configuration folder button on the Diagnostics pane. To use an example by hand, copy it to that folder and keep its required filename.

Every file starts with the version file format version and the rules list. Files without them are legacy and read as version 0. A file with a newer version than the running product is ignored.

Clone this wiki locally