You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/docs/build/latest-metrics-spec.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,9 @@ The latest Semantic Layer specification creates an open standard for defining me
12
12
With the new spec, you get simpler configuration without losing flexibility, faster onboarding for new contributors, and a clearer path to consistent, governed metrics across your organization.
13
13
14
14
:::info Availability
15
-
The new YAML spec is currently only available in the <Constantname="fusion_engine" />, and will be coming soon to the <Constantname="dbt_platform" /> **Latest** release track and <Constantname="core" /> v1.12 (coming in 1H 2026).
15
+
The new YAML spec is currently only available in the <Constantname="fusion_engine" />, and will be coming soon to the <Constantname="dbt_platform" /> **Latest** release track and <Constantname="core" /> v1.12.
16
+
17
+
For more information about availability, reach out to your account manager or post in the [#dbt-semantic-layer](https://getdbt.slack.com/archives/C046L0VTVR6) channel in the [dbt Community Slack](https://www.getdbt.com/community/join-the-community/).
Copy file name to clipboardExpand all lines: website/docs/docs/cloud/cloud-cli-installation.md
+34-29Lines changed: 34 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,23 @@
2
2
title: Install dbt CLI
3
3
sidebar_label: "Installation"
4
4
id: cloud-cli-installation
5
-
description: "Instructions for installing and configuring dbt CLI"
5
+
description: "Instructions for installing and configuring dbt platform's CLI tool."
6
6
pagination_next: "docs/cloud/configure-cloud-cli"
7
7
---
8
8
9
-
<Constantname="cloud" /> natively supports developing using a command line (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The <Constantname="cloud" /> CLI allows you to run dbt commands against your <Constantname="cloud" /> development environment from your local command line.
9
+
import LongSession from '/snippets/_long-sessions-cli.md';
10
10
11
-
dbt commands are run against <Constantname="cloud" />'s infrastructure and benefit from:
11
+
The <Constantname="dbt_platform" /> natively supports developing using a command line interface (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The dbt CLI allows you to run dbt commands against your <Constantname="dbt_platform" /> development environment from your local command line.
12
12
13
-
* Secure credential storage in the <Constantname="cloud" /> platform
13
+
:::note CLI compatibility
14
+
15
+
The dbt CLI is a <Constantname="dbt_platform" /> tool available to users on any [available plan](https://www.getdbt.com/pricing). It is not compatible with existing installations of the <Constantname="core" /> or <Constantname="fusion_engine" /> CLIs.
16
+
17
+
:::
18
+
19
+
dbt commands run against the platform's infrastructure and benefit from:
20
+
21
+
* Secure credential storage in the <Constantname="dbt_platform" />
14
22
*[Automatic deferral](/docs/cloud/about-cloud-develop-defer) of build artifacts to your Cloud project's production environment
15
23
* Speedier, lower-cost builds
16
24
* Support for dbt Mesh ([cross-project `ref`](/docs/mesh/govern/project-dependencies))
@@ -19,18 +27,11 @@ dbt commands are run against <Constant name="cloud" />'s infrastructure and bene
19
27
<Lightboxsrc="/img/docs/dbt-cloud/cloud-cli-overview.jpg"title="Diagram of how the dbt CLI works with dbt's infrastructure to run dbt commands from your local command line." />
20
28
21
29
## Prerequisites
22
-
The <Constantname="cloud" /> CLI is available in all [deployment regions](/docs/cloud/about-cloud/access-regions-ip-addresses) and for both multi-tenant and single-tenant accounts.
30
+
The <Constantname="cloud_CLI" /> is available in all [deployment regions](/docs/cloud/about-cloud/access-regions-ip-addresses) and for both multi-tenant and single-tenant accounts.
23
31
24
32
## Install dbt CLI
25
33
26
-
You can install the <Constantname="cloud" /> CLI on the command line by using one of these methods.
27
-
28
-
<details>
29
-
<summary>View a video tutorial for a step-by-step guide to installation.</summary>
You can install the <Constantname="cloud_cli" /> via the command line by using one of the following methods:
34
35
35
36
<TabsqueryString="install">
36
37
@@ -68,14 +69,14 @@ pip uninstall dbt
68
69
```
69
70
If you have multiple taps, use `brew install dbt-labs/dbt-cli/dbt`.
70
71
71
-
3. Verify your installation by running `dbt --help`in the command line. If you see the following output, your installation is correct:
72
+
3. Verify your installation by running `dbt --help`in the command line. If you see the following output, you installed it correctly:
72
73
```bash
73
74
The dbt CLI - an ELT tool forrunning SQL transformations and data modelsin dbt...
74
75
```
75
76
76
77
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
77
78
78
-
* Note that you no longer need to run the `dbt deps` command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
79
+
* Note that you no longer need to run the `dbt deps` command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
79
80
80
81
4. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
81
82
@@ -93,7 +94,7 @@ Refer to the [FAQs](#faqs) if your operating system runs into path conflicts.
93
94
94
95
:::info
95
96
96
-
Advanced users can configure multiple projects to use the same <Constant name="cloud" /> CLI by:
97
+
Advanced users can configure multiple projects to use the same <Constant name="cloud_cli" /> by:
97
98
98
99
1. Placing the executable file (`.exe`) in the "Program Files" folder
99
100
2. [Adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53)
@@ -102,14 +103,14 @@ Advanced users can configure multiple projects to use the same <Constant name="c
102
103
Note that if you're using VS Code, you must restart it to pick up modified environment variables.
103
104
:::
104
105
105
-
4. Verify your installation by running `./dbt --help`in the command line. If you see the following output, your installation is correct:
106
+
4. Verify your installation by running `./dbt --help`in the command line. If you see the following output, you installed it correctly:
106
107
```bash
107
108
The dbt CLI - an ELT tool forrunning SQL transformations and data modelsin dbt...
108
109
```
109
110
110
111
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
111
112
112
-
* Note that you no longer need to run the `dbt deps` command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
113
+
* Note that you no longer need to run the `dbt deps` command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
113
114
114
115
5. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
115
116
@@ -136,14 +137,14 @@ Advanced users can configure multiple projects to use the same dbt CLI executabl
136
137
137
138
:::
138
139
139
-
3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct:
140
+
3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, you installed it correctly:
140
141
```bash
141
142
The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...
142
143
```
143
144
144
145
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
145
146
146
-
* Note that you no longer need to run the `dbt deps`command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps`if you make any changes to your `packages.yml` file.
147
+
* Note that you no longer need to run the `dbt deps`command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps`if you make any changes to your `packages.yml` file.
147
148
148
149
4. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
149
150
@@ -168,7 +169,7 @@ If you already have dbt Core installed, the <Constant name="cloud_cli" /> may co
168
169
169
170
--------
170
171
171
-
Before installing the <Constant name="cloud_cli" />, make sure you have Python installed and your virtual environment venv or pyenv. If you already have a Python environment configured, you can skip to the [pip installation step](#install-dbt-cloud-cli-in-pip).
172
+
Before installing the <Constant name="cloud_cli" />, make sure you have Python installed and your virtual environment (venv or pyenv) configured. If you already have a Python environment configured, you can skip to the [pip installation step](#install-dbt-cloud-cli-in-pip).
172
173
173
174
### Install a virtual environment
174
175
@@ -197,7 +198,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`.
197
198
dbt --version
198
199
```
199
200
200
-
2. Make sure you're in your virtual environment and run the following command to install the <Constant name="cloud" /> CLI:
201
+
2. Make sure you're in your virtual environment and run the following command to install the <Constant name="cloud_cli" />:
201
202
202
203
```bash
203
204
pip install dbt --no-cache-dir
@@ -208,7 +209,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`.
208
209
pip install dbt --no-cache-dir --force-reinstall
209
210
```
210
211
211
-
3. (Optional) To revert to <Constant name="core" />, first uninstall both the <Constant name="cloud" /> CLI and <Constant name="core" />. Then reinstall <Constant name="core" />.
212
+
3. (Optional) To revert to <Constant name="core" />, first uninstall both the <Constant name="cloud_cli" /> and <Constant name="core" />. Then reinstall <Constant name="core" />.
212
213
213
214
```bash
214
215
pip uninstall dbt-core dbt
@@ -233,19 +234,19 @@ The following instructions explain how to update the <Constant name="cloud_cli"
233
234
234
235
<TabItem value="mac" label="macOS (brew)">
235
236
236
-
To update the <Constant name="cloud_cli" /> run `brew update` and then `brew upgrade dbt`.
237
+
To update the <Constant name="cloud_cli" />, run `brew update` and then `brew upgrade dbt`.
To update, follow the same process explained in [Windows](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one.
243
+
To update, follow the [Windows installation instructions](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one.
To update, follow the same process explained in [Linux](/docs/cloud/cloud-cli-installation?install=linux#install-dbt-cloud-cli) and replace the existing `dbt` executable with the new one.
249
+
To update, follow the [Linux installation instructions](/docs/cloud/cloud-cli-installation?install=linux#install-dbt-cloud-cli) and replace the existing `dbt` executable with the new one.
249
250
250
251
</TabItem>
251
252
@@ -272,7 +273,7 @@ import CloudCliRelativePath from '/snippets/_cloud-cli-relative-path.md';
272
273
273
274
The <Constant name="cloud_cli" /> and <a href="https://github.com/dbt-labs/dbt-core">dbt Core</a>, an open-source project, are both command line tools that enable you to run dbt commands.
274
275
275
-
The key distinction is the <Constant name="cloud_cli" /> is tailored for <Constant name="cloud" />'s infrastructure and integrates with all its <a href="https://docs.getdbt.com/docs/cloud/about-cloud/dbt-cloud-features">features</a>.
276
+
The key distinction is that the <Constant name="cloud_cli" /> is tailored for the <Constant name="dbt_platform" />'s infrastructure and integrates with all its <a href="https://docs.getdbt.com/docs/cloud/about-cloud/dbt-cloud-features">features</a>.
276
277
277
278
</DetailsToggle>
278
279
@@ -314,9 +315,13 @@ This alias will allow you to use the <code>dbt-cloud</code> command to invoke th
314
315
315
316
<DetailsToggle alt_header="Why am I receiving a `Stuck session` error when trying to run a new command?">
316
317
317
-
The<Constant name="cloud_cli" /> allows only one command that writes to the data warehouse at a time. If you attempt to run multiple write commands simultaneously (for example, `dbt run` and `dbt build`), you will encounter a `stuck session` error. To resolve this, cancel the specific invocation by passing its ID to the cancel command. For more information, refer to [parallel execution](/reference/dbt-commands#parallel-execution).
318
+
The<Constant name="cloud_cli" /> allows only one command that writes to the data warehouse at a time. If you attempt to run multiple write commands simultaneously (for example, `dbt run` and `dbt build`), you will encounter a `stuck session` error. To resolve this, cancel the specific invocation by passing its ID to the cancel command. For more information, refer to [parallel execution](/reference/dbt-commands#parallel-execution).
0 commit comments