dbt_cloud.yml file

The dbt_cloud.yml file stores the credentials that dbt tools — like the dbt CLI, the dbt VS Code extension, and more — use to authenticate with dbt platform. You can download it from dbt platform and save it locally to your .dbt directory.

This page covers:

• How to download it and set up the .dbt directory for the dbt CLI or the VS Code extension
• The file structure and field reference
• The companion dbt-cloud block in dbt_project.yml

Keep this file safe

The dbt_cloud.yml file contains API keys. Store it securely and make sure you do not commit it to version control.

Download dbt_cloud.yml

How you download the file depends on whether you're configuring the dbt CLI or the dbt VS Code extension.

1. In dbt platform, select the project you want to work on. The project must already have a development environment set up.
2. Go to Account settings → Your profile, then follow the steps for your tool:

• dbt CLI: Navigate to CLI → Configure Cloud authentication and click Download CLI configuration file.
• dbt VS Code extension: Navigate to VS Code Extension → Set up your credentials and click Download credentials. The downloaded dbt_cloud.yml includes your Personal access token (PAT).

3. Move the file to your .dbt directory. If you don't have one yet, try one of these quick setup (one command) options:

   Mac / Linux

   mkdir -p ~/.dbt && mv ~/Downloads/dbt_cloud.yml ~/.dbt/dbt_cloud.yml

   Windows

   mkdir %USERPROFILE%\.dbt 2>nul & move %USERPROFILE%\Downloads\dbt_cloud.yml %USERPROFILE%\.dbt\dbt_cloud.yml
    Manually create and move your .dbt directory

   If you've never had a .dbt directory, you should perform the following recommended steps to create one. If you already have a .dbt directory, move the dbt_cloud.yml file into it. Some information about the .dbt directory:

   • A .dbt directory is a hidden folder in the root of your filesystem. It's used to store your dbt configuration files. The . prefix is used to create a hidden folder, which means it's not visible in Finder or File Explorer by default.
   • To view hidden files and folders, press Command + Shift + G on macOS or Ctrl + Shift + G on Windows. This opens the "Go to Folder" dialog where you can search for the .dbt directory.

   Create a .dbt directory

   1. Clone your dbt project repository locally.
   2. Use the mkdir command followed by the name of the folder you want to create.

   • If using macOS, add the ~ prefix to create a .dbt folder in the root of your filesystem:
     • macOS: mkdir ~/.dbt
     • Windows: mkdir %USERPROFILE%\.dbt

   Move the dbt_cloud.yml file

   You can move the dbt_cloud.yml file into the .dbt directory using the mv command or by dragging and dropping the file into the .dbt directory by opening the Downloads folder using the "Go to Folder" dialog and then using drag-and-drop in the UI.

   To move the file using the terminal, use the mv/move command. This command moves the dbt_cloud.yml from the Downloads folder to the .dbt folder. If your dbt_cloud.yml file is located elsewhere, adjust the path accordingly.

   Mac or Linux

   In your command line, use the mv command to move your dbt_cloud.yml file into the .dbt directory. If you've just downloaded the dbt_cloud.yml file and it's in your Downloads folder, the command might look something like this:

   mv ~/Downloads/dbt_cloud.yml ~/.dbt/dbt_cloud.yml

   Windows

   In your command line, use the move command. Assuming your file is in the Downloads folder, the command might look like this:

   move %USERPROFILE%\Downloads\dbt_cloud.yml %USERPROFILE%\.dbt\dbt_cloud.yml

   If your downloaded file has a numerical suffix (for example, dbt_cloud(2).yml), rename it to dbt_cloud.yml before moving it. The dbt CLI and extension only look for the exact filename.

4. Confirm that the project-id in your dbt_project.yml dbt-cloud block matches the project you're working on. This registers and connects your tool to dbt platform and enables platform features such as Mesh and deferral.

File structure

Your dbt_cloud.yml file has the following structure:

dbt_cloud.yml

version: "1"
context:
  active-host: your_active_host       # for example, "abc123.us1.dbt.com"
  active-project: your_project_id     # for example, "123456"
projects:
  - project-name: your_project_name
    project-id: your_project_id
    account-name: your_account_name
    account-id: your_account_id
    account-host: your_account_host   # for example, "abc123.us1.dbt.com"
    token-name: your_token_name       # for example, "cloud-cli-1234"
    token-value: your_token_value

  - project-name: your_project_name
    project-id: your_project_id
    account-name: your_account_name
    account-id: your_account_id
    account-host: your_account_host
    token-name: your_token_name
    token-value: your_token_value

For example, if I had a Jaffle and wizard shop account, here's what my dbt_cloud.yml file would look like:

dbt_cloud.yml

version: "1"
context:
  active-host: "abc123.us1.dbt.com"
  active-project: "123456"
projects:
  - project-name: "Project 1"
    project-id: "123"
    account-name: "Jaffle and wizard shop" 
    account-id: "1"
    account-host: "abc123.us1.dbt.com"
    token-name: "cloud-cli-1091"
    token-value: "dbtu_token_value"            # this would be a longer token value
  - project-name: "Project 2"
    project-id: "456"
    account-name: "Jaffle and wizard shop"
    account-id: "1"
    account-host: "abc123.us1.dbt.com"
    token-name: "cloud-cli-1091"
    token-value: "dbtu_token_value"
  - project-name: "Project 3"
    project-id: "789"
    account-name: "Jaffle and wizard shop"
    account-id: "1"
    account-host: "abc123.us1.dbt.com"
    token-name: "cloud-cli-1091"
    token-value: "dbtu_token_value"

Field reference

Field	Required	Description
version	Yes	The schema version of the file. Currently "1".
context.active-host	Yes	The account-host to use by default. You can find it in the Account settings page.
context.active-project	Yes	The project-id of the project to use by default when running commands. Must match a project-id listed under projects.
context.defer-env-id	No	The environment ID to defer to for build artifacts. Optional override of the project's default deferral environment. dbt CLI only. Refer to Configure deferral.
projects.project-name	Yes	A human-readable name for the project.
projects.project-id	Yes	The dbt platform project ID. Find it in the URL when viewing your project (for example, …/projects/123456).
projects.account-name	Yes	A human-readable name for the account.
projects.account-id	Yes	The dbt platform account ID.
projects.account-host	Yes	The host for your account, for example cloud.getdbt.com, emea.dbt.com, or your single-tenant access URL.
projects.token-name	Yes	A name for the Personal access token (PAT).
projects.token-value	Yes	The PAT value. Treat this as a secret.

Loading table...

The dbt-cloud block in dbt_project.yml

The dbt-cloud block is a companion config that lives in your project's dbt_project.yml file (not in dbt_cloud.yml). It tells the dbt CLI, the Studio IDE, and Fusion which dbt platform project your local project corresponds to.

dbt_project.yml

name:
version:
# Your project configs...

dbt-cloud:
  project-id: your_project_id
  defer-env-id: '123456'  # optional

Field	Required	Description
project-id	Yes	The dbt platform project ID this local project maps to. Find it in the URL when viewing your project (for example, https://YOUR_ACCESS_URL/develop/26228/projects/123456 → 123456).
defer-env-id	No	The environment ID to defer to for build artifacts. Used for Fusion auto-deferral and dbt CLI deferral overrides.

Loading table...

Related docs

• dbt CLI
• dbt VS Code extension
• dbt_project.yml

Was this page helpful?

Privacy policyCreate a GitHub issue

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.