Skip to content
Back to search

dbt-project-evaluator

This package contains native dbt checks to report and fix issues in your dbt project

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/dbt-labs--dbt-project-evaluator/badge.svg)](/listings/dbt-labs--dbt-project-evaluator)

HTML

<a href="/listings/dbt-labs--dbt-project-evaluator"><img src="/api/listings/dbt-labs--dbt-project-evaluator/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

# packages.yml
packages:
  - package: dbt-labs/dbt_project_evaluator
    version: [">=2.0.0", "<3.0.0"]

The checks then run before every `dbt build`, and on demand with `dbt check`. They are advisory by default (`severity: warn`).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 76 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # dbt_project_evaluator
  2. > [!IMPORTANT]
  3. > **Using dbt v1?** This README is for version 2, which requires dbt 2.0 or later. Stay on 1.x
  4. > (see the [README of the `1.x` branch](https://github.com/dbt-labs/dbt-project-evaluator/blob/1.x/README.md))
  5. > and cap the version in your `packages.yml` so that `dbt deps` doesn't upgrade you: `version: [">=1.0.0", "<2.0.0"]`
  6. This package highlights areas of a dbt project that are misaligned with dbt Labs' best practices.
  7. Specifically, it checks:
  8. 1. __[Modeling](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/modeling/)__ - your dbt DAG for modeling best practices
  9. 2. __[Testing](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/testing)__ - your models for testing best practices
  10. 3. __[Documentation](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/documentation)__ - your models for documentation best practices
  11. 4. __[Structure](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/structure)__ - your dbt project for file structure and naming best practices
  12. 5. __[Performance](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/performance)__ - your model materializations for performance best practices
  13. 6. __[Governance](https://dbt-labs.github.io/dbt-project-evaluator/latest/rules/governance)__ - your best practices for model governance features
  14. Each rule is a native [dbt check](https://docs.getdbt.com/docs/build/checks): a SQL query over the dbt information schema that runs locally and returns one row per violation. Nothing is built in your warehouse, so it needs no credentials and works with every adapter supported by dbt 2.
  15. ## Why version 2?
  16. - **Native.** Run the rules with `dbt check`, and configure them in `dbt_project.yml` like any other resource.
  17. - **Checked before every build.** A rule set to `severity: error` stops a build that breaks it.
  18. - **Fast.** About 15 seconds for a project of 1,900 models, against about 2 minutes for the 1.x `dbt build`.
  19. - **Selectable.** `--select` and `state:modified` report only the violations on the resources you changed.
  20. - **No warehouse needed.** No credentials and no compute cost, so CI needs no secrets.
  21. ## Install
  22. ```yaml
  23. # packages.yml
  24. packages:
  25. - package: dbt-labs/dbt_project_evaluator
  26. version: [">=2.0.0", "<3.0.0"]
  27. ```
  28. The checks then run before every `dbt build`, and on demand with `dbt check`. They are advisory by default (`severity: warn`).
  29. ## Use
  30. ```shell
  31. dbt check # every check
  32. dbt check fct_root_models # one check
  33. dbt check --select state:modified --state path/to/main/target # only what a pull request changes
  34. ```
  35. Set the severity of a category or of a single check in your `dbt_project.yml`:
  36. ```yaml
  37. checks:
  38. dbt_project_evaluator:
  39. structure:
  40. +severity: error # block `dbt build` on violations
  41. documentation:
  42. fct_undocumented_models:
  43. +enabled: false # turn off one rule
  44. ```
  45. More options, in the documentation:
  46. - [accept some violations as exceptions](https://dbt-labs.github.io/dbt-project-evaluator/latest/customization/exceptions/)
  47. - [change a threshold or a naming convention](https://dbt-labs.github.io/dbt-project-evaluator/latest/customization/overriding-variables/)
  48. - [exclude a package or a path](https://dbt-labs.github.io/dbt-project-evaluator/latest/customization/excluding-packages-and-paths/)
  49. - [run the checks in CI](https://dbt-labs.github.io/dbt-project-evaluator/latest/ci-check/)
  50. ## Coming from version 1?
  51. The rules are the same, but they are checks now instead of models, so the configuration changes: severity is set with `checks:`, exceptions are a var instead of a seed, and the 1.x tables are gone. `scripts/migrate_to_v2.py` converts your exceptions seed. See the [migration guide](https://dbt-labs.github.io/dbt-project-evaluator/latest/migrating-to-v2/) for all the changes.
  52. ## Agent skills
  53. The package ships three skills that teach a coding agent (Claude Code, Cursor, Codex...) how to run the checks, fix the violations and migrate from 1.x. Set `ai_provider` under `flags:` in your `dbt_project.yml` and run `dbt deps` to install them. See [Agent skills](https://dbt-labs.github.io/dbt-project-evaluator/latest/skills/).
  54. ## Documentation
  55. The rules, the configuration options, the exceptions and how to run the checks in CI are on [the documentation site](https://dbt-labs.github.io/dbt-project-evaluator/).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.