-
Notifications
You must be signed in to change notification settings - Fork 982
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add cloud cli video and alias info #4320
Changes from 6 commits
953d748
a3894dc
968b19b
640e758
2228037
c8e066a
9f814f9
7656855
f58614c
c3f50c9
5c8e41e
7bd3568
cd98958
7a38dbd
3ca3da3
2aa518b
4868ae8
736868a
54f5b14
6590e98
504090f
39231c9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -29,7 +29,7 @@ You must be on dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/db | |||||
|
||||||
## Install dbt Cloud CLI | ||||||
|
||||||
You can install the dbt Cloud CLI on the command line by using one of these methods: | ||||||
You can install the dbt Cloud CLI on the command line by using one of these methods. For a step-by-step video guide, refer to the [FAQs](#faqs). | ||||||
|
||||||
<Tabs queryString="install"> | ||||||
|
||||||
|
@@ -38,24 +38,35 @@ You can install the dbt Cloud CLI on the command line by using one of these meth | |||||
Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. | ||||||
|
||||||
|
||||||
1. Run the following command to verify that there is no conflict with a dbt Core installation on your system: | ||||||
1. Run the following command to verify that you don't already have dbt Core installed: | ||||||
|
||||||
```bash | ||||||
which dbt | ||||||
``` | ||||||
- This should return a `dbt not found`. If the dbt help text appears, use `pip uninstall dbt` to deactivate dbt Core from your machine. | ||||||
- This should return a `dbt not found`. If the dbt help text appears, use `pip uninstall dbt` to remove dbt Core from your machine. <br /> | ||||||
|
||||||
2. Install the dbt Cloud CLI with Homebrew: | ||||||
|
||||||
```bash | ||||||
brew untap dbt-labs/dbt | ||||||
brew tap dbt-labs/dbt-cli | ||||||
brew install dbt | ||||||
``` | ||||||
|
||||||
3. Verify the installation by running `dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. | ||||||
- First, remove the dbt-labs tap, the separate repository for packages, from Homebrew. This prevents Homebrew from installing packages from that repository: | ||||||
```bash | ||||||
brew untap dbt-labs/dbt | ||||||
- Then run `brew tap` to add and install the dbt Cloud CLI as a package: | ||||||
```bash | ||||||
brew tap dbt-labs/dbt-cli | ||||||
``` | ||||||
- Lastly, install the dbt Cloud CLI with Homebrew: | ||||||
```bash | ||||||
brew install dbt | ||||||
``` | ||||||
|
||||||
3. Verify the installation by running `dbt --help` from the command line. | ||||||
* If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a global dbt version installed. | ||||||
* You don't have to run the `dbt deps` command when your environment starts. Previously, you had to do it during initialization. However, you'll still need to run `dbt deps` if you make changes to your `packages.yml` file. | ||||||
|
||||||
4. After you've verified the installation, [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, execute `dbt compile` to compile a project using dbt Cloud and validate your models and tests. | ||||||
|
||||||
If you're using the dbt Cloud CLI, you can connect to your data platform directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file locally on your machine. | ||||||
|
||||||
</TabItem> | ||||||
|
||||||
<TabItem value="windows" label="Windows (native executable)"> | ||||||
|
@@ -73,9 +84,14 @@ Advanced users can configure multiple projects to use the same dbt Cloud CLI by | |||||
Note that if you are using VS Code, you must restart it to pick up modified environment variables. | ||||||
::: | ||||||
|
||||||
3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. | ||||||
3. Verify the installation by running `./dbt --help` from the command line. | ||||||
* If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. | ||||||
* You don't have to run the `dbt deps` command when your environment starts. Previously, you had to do it during initialization. However, you'll still need to run `dbt deps` if you make changes to your `packages.yml` file. | ||||||
|
||||||
4. After installation, [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, execute `dbt compile`, to compile a project using dbt Cloud and confirm that it works. | ||||||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
**Note**, that if you're using the dbt Cloud CLI, you can connect to your data platform directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file. | ||||||
|
||||||
</TabItem> | ||||||
|
||||||
<TabItem value="linux" label="Linux (native executable)"> | ||||||
|
@@ -97,23 +113,32 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa | |||||
|
||||||
::: | ||||||
|
||||||
3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. | ||||||
3. Verify the installation by running `./dbt --help` from the command line. | ||||||
* If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. | ||||||
* You don't have to run the `dbt deps` command when your environment starts. Previously, you had to do it during initialization. However, you'll still need to run `dbt deps` if you make changes to your `packages.yml` file. | ||||||
|
||||||
4. After installation, [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, execute `dbt compile`, to compile a project using dbt Cloud and confirm that it works. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
**Note**, that if you're using the dbt Cloud CLI, you can connect to your data platform directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file. | ||||||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
</TabItem> | ||||||
|
||||||
<TabItem value="pip" label="Existing dbt Core users (pip)"> | ||||||
|
||||||
:::info Use native packages or a virtual environment to avoid overriding dbt Core | ||||||
|
||||||
Installing the dbt Cloud CLI with pip replaces dbt Core. This change can be avoided by using the native install method and configuring your PATH or by creating a new virtual environment. | ||||||
:::info Use native packages or a virtual environment to prevent dbt Core conflicts | ||||||
|
||||||
Otherwise, to switch back to dbt Core, uninstall the dbt Cloud CLI and follow the dbt Core installation instructions. | ||||||
To prevent overwriting dbt Core, avoid installing the dbt Cloud CLI with pip. Instead, consider using the native installation method and configuring your PATH or create a new virtual environment. | ||||||
|
||||||
If you've already installed the dbt Cloud CLI and need to switch back to dbt Core, uninstall the dbt Cloud CLI, and follow the dbt Core installation instructions. | ||||||
|
||||||
You can also have both dbt Cloud CLI and dbt Core installed simultaneously. To avoid conflicts, alias the dbt Cloud CLI as `dbt-cloud`. For more details, check the [FAQs](#faqs) if your operating system experiences path conflicts. | ||||||
::: | ||||||
|
||||||
::: | ||||||
|
||||||
Before installing the dbt 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). | ||||||
|
||||||
|
||||||
### Install a virtual environment | ||||||
|
||||||
We recommend using virtual environments (venv) to namespace `cloud-cli`. | ||||||
|
@@ -156,6 +181,10 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`. | |||||
pip3 install dbt-core==VERSION | ||||||
``` | ||||||
|
||||||
4. After installation, [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, execute `dbt compile`, to compile a project using dbt Cloud and confirm that it works. | ||||||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
**Note**, that if you're using the dbt Cloud CLI, you can connect to your data platform directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file. | ||||||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
</TabItem> | ||||||
|
||||||
</Tabs> | ||||||
|
@@ -198,16 +227,6 @@ To update: | |||||
|
||||||
</Tabs> | ||||||
|
||||||
|
||||||
## Next steps | ||||||
|
||||||
After installation, you can [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. | ||||||
|
||||||
For example, you can execute `dbt compile` to compile a project using dbt Cloud. | ||||||
|
||||||
Note, that if you're using the dbt Cloud CLI, you can connect to your data platform directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file. | ||||||
|
||||||
|
||||||
## FAQs | ||||||
|
||||||
<details> | ||||||
|
@@ -231,3 +250,12 @@ If you have dbt Core installed locally, either: | |||||
|
||||||
You can always uninstall the dbt Cloud CLI to return to using dbt Core. | ||||||
</details> | ||||||
|
||||||
<details> | ||||||
<summary>Are there any instructional videos to help guide me through installation? </summary> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not opposed to this being in the FAQs, but given what we know about scroll rates, this might get more views if we embed it directly into the instructions above, rather than/in addition to putting it here. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yea i also tried adding it in the install header but then it took up too much of the page before introducing the install steps. I could link to it but that also means it'll navigate the user to another tab (and away from the docs). Which is why i figured the faq and a link to the faq was a smoother experience (as opposed to navigating them away from the docs) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll ask if we can get pop out windows for videos |
||||||
For a video walkthrough of the installation process, refer to the following video: | ||||||
|
||||||
<LoomVideo id="dd80828306c5432a996d4580135041b6?sid=fe1895b7-1281-4e42-9968-5f7d11768000"/> | ||||||
|
||||||
</details> | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we drop some sample text of what the expected output is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i thought about it and opted to leave it out because
dbt --help
returns a pretty long output (basically it gives users all the flags/commands they can use) so i decided to leave it out and thought that the 'help text...' would be clear enoughThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"
dbt --help
returns a pretty long output.." is the text that indicates it is successfully running for cloud going to be immediately apparent in this output or will they have to dig for it? Maybe including just a sample of what to look for so they know 100% it was successful?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'm maybe just confused by what this sentence is saying. Are we saying that the ability to run
dbt --help
is enough to confirm installation, or are they supposed to see something that specifically states it's the Cloud CLI and not the Core CLI? If it's the former, maybe we can clarify it by saying something like: "If the installation was successful, executingdbt --help
will produce a list of commands available to run."There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok maybe this clarifies it further?