From c87c133f970348b97998a9fedc001d3085e0b045 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:29:52 +0100 Subject: [PATCH 01/17] Update cloud-cli-installation.md update alpha docs with new changes --- .../docs/docs/cloud/cloud-cli-installation.md | 177 +++++++++++++----- 1 file changed, 125 insertions(+), 52 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 68a8ef365d6..efded6041dc 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -1,5 +1,5 @@ --- -title: Installing the dbt Cloud CLI (Alpha) +title: Install the dbt Cloud CLI (Alpha) id: cloud-cli-installation description: "Instructions for installing and configuring dbt Cloud CLI" --- @@ -12,99 +12,172 @@ These instructions are not intended for general audiences at this time. ::: -## Installing dbt Cloud CLI -### Install and update with Brew on MacOS (recommended) +dbt Cloud natively supports developing using a command line (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The dbt Cloud CLI allows you to run dbt commands against your dbt Cloud development environment from your local command line. -1. Install the dbt Cloud CLI: +dbt commands are run against dbt Cloud's infrastructure and benefit from: + +* Secure credential storage in the dbt Cloud platform. +* Automatic deferral of build artifacts to your Cloud project's production environment. +* Speedier, lower-cost builds. +* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), +* Significant platform improvements, to be released over the coming months. + +The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). + +## Install dbt Cloud CLI + +You can install the dbt Cloud CLI on the command line by using one of these methods: +* Note, the `dbt deps` command is not required anymore. + + + + + +Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Run the following command to verify that there is no conflict with a dbt Core installation on your system: + +```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. + +2. Install the dbt Cloud CLI with Homebrew: ```bash brew tap dbt-labs/dbt-cli brew install dbt-cloud-cli ``` -2. Verify the installation by requesting your homebrew installation path (not your dbt core installs). If the `which dbt` command returns nothing, then you should modify your PATH in `~.zshrc` or create an alias. +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. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Windows release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). + +2. Extract the `dbt.exe` executeable into the same folder as your dbt project. + +:::info + +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). + +Note that if you are using VS Code, you'll need to 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. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Linux release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). (Pick the file based on your CPU architecture) + +2. Extract the `dbt-cloud-cli` binary to the same folder as your dbt project. ```bash -which dbt -dbt --help +tar -xf dbt_0.29.9_linux_amd64.tar.gz +./dbt --version ``` -### Manually install (Windows and Linux) +:::info -1. Download the latest release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). -2. Add the `dbt` executable to your path. -3. Move to a directory with a dbt project, and create a `dbt_cloud.yml` file containing your `project-id` from dbt Cloud. -4. Invoke `dbt --help` from your terminal to see a list of supported commands. +Advanced users can configure multiple projects to use the same Cloud CLI executable by adding it to their PATH environment variable in their shell profile. -#### Updating your dbt Cloud installation (Windows + Linux) +::: -Follow the same process in [Installing dbt Cloud CLI](#manually-install-windows-only) and replace the existing `dbt` executable with the new one. You should not have to go through the security steps again. +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."> -## Setting up the CLI + -The following instructions are for setting up the dbt Cloud CLI. + -1. Ensure that you have created a project in [dbt Cloud](https://cloud.getdbt.com/). +## Update dbt Cloud CLI -2. Ensure that your personal [development credentials](https://cloud.getdbt.com/settings/profile/credentials) are set on the project. +The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. -3. Navigate to [your profile](https://cloud.getdbt.com/settings/profile) and enable the **Beta** flag under **Experimental Features.** +#### Update with Homebrew (MacOS) -4. Create an environment variable with your [dbt Cloud API key](https://cloud.getdbt.com/settings/profile#api-access): +To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. +#### Update manually (Windows and Linux) -```bash -vi ~/.zshrc +To update, follow the same process explained in [Install manually (Windows)](#install-manually-windows) and replace the existing `dbt.exe` executable with the new one. -# dbt Cloud CLI -export DBT_CLOUD_API_KEY="1234" # Replace "1234" with your API key -``` -5. Load the new environment variable. Note: You may need to reactivate your Python virtual environment after sourcing your shell's dot file. Alternatively, restart your shell instead of sourcing the shell's dot file +## Configure the dbt Cloud CLI + +After installation, you can configure 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 the following commands to compile a project using dbt Cloud: ```bash -source ~/.zshrc +dbt compile ``` -6. Navigate to a dbt project +### Prerequisites + +- You must set up a project in dbt Cloud. +- You must have your [personal development credentials](/docs/dbt-cloud-environments#set-developer-credentials) set for that project. The dbt Cloud CLI will use these credentials, stored securely in dbt Cloud, to communicate with your data platform. +- You must [enroll](/docs/dbt-versions/experimental-features) in the dbt Cloud beta features. + - To enroll, navigate to your **Profile Settings** and enable the **Beta** flag under **Experimental Features**. + +Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt Cloud project. + +1. Ensure you meet the prerequisites above. +2. Create an environment variable with your [dbt Cloud API key](/docs/dbt-cloud-apis/user-tokens): + - On MacOS, Linux, or Windows add an environment variable: + + ```bash + export DBT_CLOUD_API_KEY="1234" # Replace 1234 with your API key + ``` + + - In Powershell, add an environment variable: IS THIS MISSING SOMETHING? + - Note that this variable resets if you restart your shell. To add an environment variable permanently, add a system environment variable in your platform. + +3. Navigate to a dbt project in your terminal: ```bash cd ~/dbt-projects/jaffle_shop ``` -7. Create a `dbt_cloud.yml` in the root project directory. The file is required to have a `project-id` field with a valid [project ID](#glossary). Enter the following commands: +4. In your `dbt_project.yml` file, ensure there is a section titled `dbt-cloud`. This section is required to have a `project-id` field with a valid project ID. -```bash -pwd # Input -/Users/user/dbt-projects/jaffle_shop # Output -``` +```yaml +# dbt_project.yml +name: -```bash -echo "project-id: ''" > dbt_cloud.yml # Input -``` +version: +... -```bash -cat dbt_cloud.yml # Input -project-id: '123456' # Output +dbt-cloud: + project-id: PROJECT_ID ``` -You can find your project ID by selecting your project and clicking on **Develop** in the navigation bar. Your project ID is the number in the URL: https://cloud.getdbt.com/develop/26228/projects/PROJECT_ID. +- To find your project ID, go to **Develop** in the navigation menu. Select the dbt Cloud project URL, such as `https://cloud.getdbt.com/develop/26228/projects123456`, where the project ID is `123456`. -If `dbt_cloud.yml` already exists, edit the file, and verify the project ID field uses a valid project ID. -#### Upgrade the CLI with Brew +## Use the dbt Cloud CLI -```bash -brew update -brew upgrade dbt-cloud-cli -``` +The dbt Cloud CLI shares the same set of commands as dbt Core. When you invoke a dbt command, that command is sent to dbt Cloud for processing. + +The dbt Cloud CLI supports [project dependencies](/docs/collaborate/govern/project-dependencies), which is an exciting way to depend on another project using the metadata service in dbt Cloud. It instantly resolves references (or `ref`) to public models defined in other projects. You don't need to execute or analyze these upstream models yourself. Instead, you treat them as an API that returns a dataset. + +Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). + + +## FAQs + +
-## Using dbt Cloud CLI +How do I solve for path conflicts +For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). -**Coming soon** +If you have dbt Core installed locally, ensure that you deactivate your Python environment or uninstall it using `pip uninstall dbt` before proceeding. Alternatively, advanced users can modify the $PATH environment variable to correctly point to the dbt Cloud CLI binary to use both dbt Cloud CLI and dbt Core together. -## Glossary +You can always uninstall the Cloud CLI to return to using dbt Core. +
-- **dbt cloud API key:** Your API key found by navigating to the **gear icon**, clicking **Profile Settings**, and scrolling down to **API**. -- **Project ID:** The ID of the dbt project you're working with. Can be retrieved from the dbt Cloud URL after a project has been selected, for example, `https://cloud.getdbt.com/deploy/{accountID}/projects/{projectID}` -- **Development credentials:** Your personal warehouse credentials for the project you’re working with. They can be set by selecting the project and entering them in dbt Cloud. Navigate to the **gear icon**, click **Profile Settings**, and click **Credentials** from the left-side menu. From ecd32c779b49d09e45f6a10644f8de73cd1e3235 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:47:40 +0100 Subject: [PATCH 02/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index efded6041dc..3d7d13817c9 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -28,7 +28,6 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- ## Install dbt Cloud CLI You can install the dbt Cloud CLI on the command line by using one of these methods: -* Note, the `dbt deps` command is not required anymore. From c7c1db9b52b1e1df001de7f08c7c3eab941fb670 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:49:44 +0100 Subject: [PATCH 03/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 3d7d13817c9..675efcb600b 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -51,6 +51,8 @@ brew install dbt-cloud-cli 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 no longer need to use the `dbt deps` command. Previously, you had to run that command. + From 011f50b0b41d4e979dffb4377d0a6462fc34ba43 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:50:03 +0100 Subject: [PATCH 04/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 675efcb600b..576765d4427 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -72,6 +72,8 @@ Note that if you are using VS Code, you'll need to restart it to pick up modifie 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 no longer need to use the `dbt deps` command. Previously, you had to run that command. + From 0530de724e5e3a195137332fad0aa5cdd7e40b68 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:50:48 +0100 Subject: [PATCH 05/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 576765d4427..6b5330f0acd 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -95,7 +95,9 @@ 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 no longer need to use the `dbt deps` command. Previously, you had to run that command. From 90ac0339647ec5c22a9c58fdd7f070f1f288cc3c Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:51:05 +0100 Subject: [PATCH 06/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 6b5330f0acd..fc14c7bed8d 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -123,7 +123,7 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje dbt compile ``` -### Prerequisites +**Prerequisites** - You must set up a project in dbt Cloud. - You must have your [personal development credentials](/docs/dbt-cloud-environments#set-developer-credentials) set for that project. The dbt Cloud CLI will use these credentials, stored securely in dbt Cloud, to communicate with your data platform. From 8034bdd493fc7bc75d411cf6e26b8e2f5b827ace Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:53:16 +0100 Subject: [PATCH 07/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index fc14c7bed8d..839c75557ad 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -121,7 +121,6 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje ```bash dbt compile -``` **Prerequisites** From 7ba82e2ad2282cedae7ee4f71e6aea9ed4f17f4c Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:53:28 +0100 Subject: [PATCH 08/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 839c75557ad..96286838fdc 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -117,7 +117,7 @@ To update, follow the same process explained in [Install manually (Windows)](#in ## Configure the dbt Cloud CLI -After installation, you can configure 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 the following commands to compile a project using dbt Cloud: +After installation, you can configure 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 the following command to compile a project using dbt Cloud: ```bash dbt compile From f36307902ad0836f07ddaf4f9aafe866ebb200b5 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:10:55 +0100 Subject: [PATCH 09/17] Update cloud-cli-installation.md add tabs --- website/docs/docs/cloud/cloud-cli-installation.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 96286838fdc..854ce15fb01 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -107,13 +107,21 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. -#### Update with Homebrew (MacOS) + + + + + ## Configure the dbt Cloud CLI @@ -121,6 +129,7 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje ```bash dbt compile +``` **Prerequisites** From a9346b793789d3de7ddbe95ec3b5416aacf5948f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:12:07 +0100 Subject: [PATCH 10/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 854ce15fb01..395cc33f72a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -186,6 +186,11 @@ Share feedback or request features you'd like to see on the [dbt community Slack
+What's the difference between the dbt Cloud CLI and dbt Core? +The dbt Cloud CLI and dbt Core, an open-source project, are both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its features. + +
+ How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). From 63977c148e4330101f1a5e0b544c066834f41b4e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:24:38 +0100 Subject: [PATCH 11/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 395cc33f72a..a2a00fd2b73 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -29,7 +29,7 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: - + @@ -65,7 +65,7 @@ If your operating system runs into path conflicts, refer to the [FAQs](#faqs). :::info -Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). Note that if you are using VS Code, you'll need to restart it to pick up modified environment variables. ::: @@ -117,7 +117,7 @@ To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. From 17c84f7111baf56987c7daf623af690b3ee0512f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:32:40 +0100 Subject: [PATCH 12/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index a2a00fd2b73..aa8a6e48157 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -30,7 +30,6 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: - Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). @@ -100,7 +99,6 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa * You no longer need to use the `dbt deps` command. Previously, you had to run that command. - ## Update dbt Cloud CLI @@ -108,19 +106,16 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. - - ## Configure the dbt Cloud CLI From 97856f13ed33e71ade1ab04c6fb9f021a87eaae6 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:42:16 +0100 Subject: [PATCH 13/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index aa8a6e48157..0c5c7cc134f 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -30,6 +30,7 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: + Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). @@ -99,6 +100,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa * You no longer need to use the `dbt deps` command. Previously, you had to run that command. + ## Update dbt Cloud CLI @@ -106,16 +108,18 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. - To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. - To update, follow the same process explained in [Install manually (Windows)](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one. + ## Configure the dbt Cloud CLI From bc9bcd42b60ba7086dc36c7b00f1ced847ec28cb Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:58:54 +0100 Subject: [PATCH 14/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 0c5c7cc134f..00b85a4603a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -1,5 +1,5 @@ --- -title: Install the dbt Cloud CLI (Alpha) +title: Installing the dbt Cloud CLI (Alpha) id: cloud-cli-installation description: "Instructions for installing and configuring dbt Cloud CLI" --- @@ -190,6 +190,7 @@ The dbt Cloud CLI and dbt Core +
How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). From 5dde8fa15ffa88198c04d4a0ac67a1c16907c25e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:08:06 +0100 Subject: [PATCH 15/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 00b85a4603a..43bc70e1805 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -20,7 +20,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Secure credential storage in the dbt Cloud platform. * Automatic deferral of build artifacts to your Cloud project's production environment. * Speedier, lower-cost builds. -* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), +* Support for dbt Mesh ([cross-project `ref`](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). From 2ff2ee391e040aa9f3ad295a49f5c9c19b28cfab Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:08:38 +0100 Subject: [PATCH 16/17] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 43bc70e1805..94c10a7e4f8 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -109,12 +109,12 @@ The following instructions explain how to update the dbt CLoud CLI to the latest - + To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. - + To update, follow the same process explained in [Install manually (Windows)](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one. From fa36b4847ac806e521babfb9ababfe5c3ff9e125 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:16:40 +0100 Subject: [PATCH 17/17] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 94c10a7e4f8..0140f271f92 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -23,7 +23,6 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Support for dbt Mesh ([cross-project `ref`](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. -The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). ## Install dbt Cloud CLI