CLI to autofix deprecations in dbt projects
Project description
dbt-autofix
dbt-autofix automatically scans your dbt project for deprecated configurations and updates them to align with the latest best practices. This makes it easier to resolve deprecation warnings introduced in dbt v1.10 as well as prepare for migration to the dbt Fusion engine.
There will also be cases that dbt-autofix cannot resolve and require manual intervention. For those scenarios, using AI Agents can be helpfiul see the below section on Using AGENTS.md. Even if you don't intend to use LLMs, the AGENTS.md can be a very helpful guidance for work that may need to be done after autofix has done it's part.
Deprecation Coverage - Project Files
The following deprecations are covered by dbt-autofix deprecations:
| Deprecation Code in dbt Core | Files | Handling | Support | Behavior Change |
|---|---|---|---|---|
PropertyMovedToConfigDeprecation |
YAML files | Move all deprecated property-level configs under config: in YAML files across all resource types (models, exposures, owners, etc) |
Full | No |
CustomKeyInObjectDeprecation |
YAML files | Move all models extra config (not valid or custom) under meta: and meta under config: |
Full | No |
DuplicateYAMLKeysDeprecation |
YAML files | Remove duplicate keys in YAML files, keeping the second one to keep the same behaviour | Full | No |
CustomTopLevelKeyDeprecation |
YAML files | Delete custom top-level key-value pairs in YAML files | Full | No |
UnexpectedJinjaBlockDeprecation |
SQL files | Remove extra {% endmacro %} and {% endif %} that don't have corresponding opening statements |
Full | No |
MissingPlusPrefixDeprecation |
dbt_project.yml |
Prefix all built-in configs for models/tests etc... with a + |
Partial (Does not yet prefix custom configs) | No |
ConfigDataPathDeprecation |
dbt_project.yml |
Remove deprecated config for data path (now seed) | Full | No |
ConfigLogPathDeprecation |
dbt_project.yml |
Remove deprecated config for log path | Full | No |
ConfigSourcePathDeprecation |
dbt_project.yml |
Remove deprecated config for source path | Full | No |
ConfigTargetPathDeprecation |
dbt_project.yml |
Remove deprecated config for target path | Full | No |
ExposureNameDeprecation |
YAML files | Replaces spaces with underscores and removes non-alphanumeric characters in exposure names | Full | Yes |
ResourceNamesWithSpacesDeprecation |
SQL files, YAML files | Replaces spaces with underscores in resource names, updating .sql filenames as necessary | Full | Yes |
SourceFreshnessProjectHooksNotRun |
dbt_project.yml |
Set source_freshness_run_project_hooks in dbt_project.yml "flags" to true |
Full | Yes |
MissingArgumentsPropertyInGenericTestDeprecation |
YAML files | Move any keyword arguments defined as top-level property on generic test to arguments property |
Full | No |
Deprecation Coverage - CLI Commands
The following deprecations are covered by dbt-autofix jobs:
| Deprecation Code in dbt | Handling | Support | Behavior Change |
|---|---|---|---|
ModelParamUsageDeprecation |
Replace -m/--model with -s/--select | Full | No |
CustomOutputPathInSourceFreshnessDeprecation |
Remove -o/--output usage in dbt source freshness commands |
Full | Yes |
Installation
From PyPi
With uv (recommended)
We recommend using uv/uvx to run the package.
If you don't have uv installed, you can install uv and uvx, following the instructions on the offical website.
- to run the latest version of the tool:
uvx dbt-autofix - to run a specific version of the tool:
uvx dbt-autofix@0.1.2 - to install the tool as a dedicated CLI:
uv tool install dbt-autofix
With pip
You can also use pip if you prefer, but we then recommend installing the tool in its own Python virtual environment. Once in a venv, install the tool with pip install dbt-autofix and then run dbt-autofix ...
From the source repo
To run it from the git repo directly, install uv following those instructions and then:
run the tool directly
uvx --from git+https://github.com/dbt-labs/dbt-autofix.git dbt-autofix --help
or install it so that it can be run with dbt-cleanup in the future
uv tool install --from git+https://github.com/dbt-labs/dbt-autofix.git dbt-autofix
Usage
deprecations - the main one
dbt-autofix deprecations: refactor YAML and SQL files to fix some deprecations- add
--path <mypath>to configure the path of the dbt project (defaults to.) - add
--dry-runfor running in dry run mode - add
--jsonto get resulting data in a JSONL format - add
--json-schema-version v2.0.0-beta.4to get the JSON schema from a specific Fusion release (by default we pick the latest) - add
--select <path>to only select files in a given path (by default the tool will look at all files of the dbt project) - add
--include-packagesto also autofix the packages installed. Just note that those fixes will be reverted at the nextdbt depsand the long term fix will be to update the packages to versions compatible with Fusion. - add
--behavior-changeto run the subset of fixes that would resolve deprecations that require a behavior change. Refer to the coverage tables above to determine which deprecations require behavior changes.
- add
Each JSON object will have the following keys:
- "mode": "applied" or "dry_run"
- "file_path": the full path of the file modified. Each file will appear only once
- "refactors": the list of refactoring rules applied
Calling deprecations without --dry-run should be safe if your dbt code is part of a git repo.
Please review the suggested changes to your dbt project before merging to main and make those changes go through your typical CI/CD process.
jobs
dbt-autofix jobs: update dbt platform jobs steps to use -s/--select selectors instead of -m/--models/--model which are deprecated in the Fusion engine
Run dbt-autofix jobs --help to see the required parameters and supported arguments.
This tool requires connecting to the dbt Admin API to retrieve and update jobs which means that the user token or service token used need to have Read and Write access to jobs
Running with --dry-run/d will output what changes would have been triggered without triggering them
Running with --behavior-changes will run the subset of fixes that would resolve deprecations that require a behavior change. Refer to the coverage tables above to determine which deprecations require behavior changes.
Using AGENTS.md
AGENTS.md is provided as a reference and starting place for those interested in using AI agents in Cursor, Copilot Chat, and Claude Code to try resolving remaining errors after running dbt-autofix.
To use AGENTS.md:
- Download AGENTS.md and the /manual_fixes/ directory (you can remove these files after using the agentic autofix workflow)
- Add AGENTS.md as context to the chat or Claude Code
- Be very specific in your prompt to provide the proper guardrails and avoid AI hallucinations
Sample prompt:
Please make my dbt project compatible with Fusion by strictly following the instructions in AGENTS.md. Please read AGENTS.md and dependent resources in full before you start, and take time planning and thinking through steps.
Share your manual fixes!
Have you had to make manual adjustments to get your dbt project working with Fusion? We’d love for you to contribute them back to the community through this agentic workflow!
The /manual_fixes/ folder is a collection of real examples where users have solved compatibility issues manually, and we would love your contribution to it. Your contribution helps improve autofix for everyone and can prevent others from hitting the same issue.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dbt_autofix-0.13.2.tar.gz.
File metadata
- Download URL: dbt_autofix-0.13.2.tar.gz
- Upload date:
- Size: 73.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8328ad0992f93965294a0e10962de4f6fd2849579551117274ec0ea6e7320ae9
|
|
| MD5 |
77ee70f975051505950b878fe8643e4b
|
|
| BLAKE2b-256 |
b80061fc6d7f8a8c0c00f0404e3b49da1f0f5555f5b9b57c47807605431b92d0
|
Provenance
The following attestation bundles were made for dbt_autofix-0.13.2.tar.gz:
Publisher:
release.yml on dbt-labs/dbt-autofix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dbt_autofix-0.13.2.tar.gz -
Subject digest:
8328ad0992f93965294a0e10962de4f6fd2849579551117274ec0ea6e7320ae9 - Sigstore transparency entry: 623177296
- Sigstore integration time:
-
Permalink:
dbt-labs/dbt-autofix@cf2584fbbcd4dce886c3acd4b41436b365beb063 -
Branch / Tag:
refs/tags/v0.13.2 - Owner: https://github.com/dbt-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cf2584fbbcd4dce886c3acd4b41436b365beb063 -
Trigger Event:
push
-
Statement type:
File details
Details for the file dbt_autofix-0.13.2-py3-none-any.whl.
File metadata
- Download URL: dbt_autofix-0.13.2-py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4bab146622f7e491746395630e3481f605040e7b0f961691719810a3f4b108cb
|
|
| MD5 |
e4e45f28769a92ec94d3a739ecd8db1d
|
|
| BLAKE2b-256 |
2542d999a825fa32fc217863af8a471ea74f150ffb0015eebdf8ce90f6422fb9
|
Provenance
The following attestation bundles were made for dbt_autofix-0.13.2-py3-none-any.whl:
Publisher:
release.yml on dbt-labs/dbt-autofix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dbt_autofix-0.13.2-py3-none-any.whl -
Subject digest:
4bab146622f7e491746395630e3481f605040e7b0f961691719810a3f4b108cb - Sigstore transparency entry: 623177301
- Sigstore integration time:
-
Permalink:
dbt-labs/dbt-autofix@cf2584fbbcd4dce886c3acd4b41436b365beb063 -
Branch / Tag:
refs/tags/v0.13.2 - Owner: https://github.com/dbt-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cf2584fbbcd4dce886c3acd4b41436b365beb063 -
Trigger Event:
push
-
Statement type: