name

dbt_project.yml
name: string

Definition

Required configuration

The name of a dbt project. Must be letters, digits and underscores only, and cannot start with a digit.

Recommendation

Often an organization has one dbt project, so it is sensible to name a project with your organization's name, in snake_case. For example:

  • name: acme
  • name: jaffle_shop
  • name: evilcorp

Troubleshooting

Invalid project name

Encountered an error while reading the project:
ERROR: Runtime Error
at path ['name']: 'jaffle-shop' does not match '^[^\\d\\W]\\w*$'
Runtime Error
Could not run dbt

This project has:

dbt_project.yml
name: jaffle-shop

In this case, change your project name to be snake_case instead:

dbt_project.yml
name: jaffle_shop