From 953d748b1867895dfed7db0d1d65e060476b4ea8 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 24 Oct 2023 12:12:26 +0100 Subject: [PATCH 01/14] adding steve's video --- .../docs/docs/cloud/cloud-cli-installation.md | 80 +++++++++++++------ 1 file changed, 54 insertions(+), 26 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 5c0d6ad543e..da651156303 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -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 video instruction step-by-step guide, refer to the [FAQs](#faqs). @@ -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.
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 a tap, which is like a separate repository for packages, from Homebrew. This stops 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 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. + +**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. + @@ -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. + +**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. + @@ -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. + +**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. + -:::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. + +**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. + @@ -198,16 +227,6 @@ To update: - -## 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
@@ -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.
+ +
+Are there any instructional videos to help guide me through installation? +For a video walkthrough of the installation process, refer to the following video: + + + +
+ From a3894dc96ec4379dc48c1126aacffd7efdc22d04 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 24 Oct 2023 15:51:36 +0100 Subject: [PATCH 02/14] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- 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 da651156303..e921c629bb0 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -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. For a video instruction step-by-step guide, refer to the [FAQs](#faqs). +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). From 640e75871e417b4e6d15a02402a03ebdbee069f5 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 24 Oct 2023 15:58:39 +0100 Subject: [PATCH 03/14] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- 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 e921c629bb0..0d8e234c698 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -47,7 +47,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo 2. Install the dbt Cloud CLI with Homebrew: - - First, remove a tap, which is like a separate repository for packages, from Homebrew. This stops Homebrew from installing packages from that repository: + - 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: From 22280372d930bd23480d62ae3ca836884fc66a5a Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 24 Oct 2023 16:09:34 +0100 Subject: [PATCH 04/14] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- 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 0d8e234c698..da6c5c53197 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -63,7 +63,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo * 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 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. +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. **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. From c8e066aa645892515e0f2564cac9b71f9559f1cd Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 24 Oct 2023 16:11:30 +0100 Subject: [PATCH 05/14] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- 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 da6c5c53197..51cf9482cc0 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -65,7 +65,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo 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. -**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. +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. From 76568550363462ee816e6be21624e566aefd6c95 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 25 Oct 2023 10:16:32 +0100 Subject: [PATCH 06/14] Update cloud-cli-installation.md clarify dbt --help output per Matt's feedbakc --- website/docs/docs/cloud/cloud-cli-installation.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 51cf9482cc0..d5e9904f137 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -23,7 +23,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: ## Prerequisites -The dbt Cloud CLI is available in all [deployment regions](/docs/cloud/about-cloud/regions-ip-addresses) and and for both multi-tenant and single-tenant accounts (Azure single-tenant not supported at this time). +The dbt Cloud CLI is available in all [deployment regions](/docs/cloud/about-cloud/regions-ip-addresses) and for both multi-tenant and single-tenant accounts (Azure single-tenant not supported at this time). You must be on dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/dbt-versions/upgrade-core-in-cloud) to upgrade. @@ -59,11 +59,16 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo 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. +3. To verify your installation, open the command line and run the command dbt --help. If your installation is correct, you should see the following output: + ```bash + The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud. For more documentation on these commands, visit: docs.getdbt.com + ``` + This output confirms that you've successfully installed the dbt Cloud CLI. If you don't see this output, please ensure that you've deactivated your pyenv or venv and don't have a global dbt version + installed. + +Note that you no longer need to run the `dbt deps` command when your environment starts. This command was previously required during initialization. However, you should still run `dbt deps` if you make any 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. +7. 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. From f58614c0c87fa83ec94b489ed19a40884d1560a4 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 25 Oct 2023 10:16:56 +0100 Subject: [PATCH 07/14] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index d5e9904f137..928c7240080 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -63,8 +63,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo ```bash The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud. For more documentation on these commands, visit: docs.getdbt.com ``` - This output confirms that you've successfully installed the dbt Cloud CLI. If you don't see this output, please ensure that you've deactivated your pyenv or venv and don't have a global dbt version - installed. + This output confirms that you've successfully installed the dbt Cloud CLI. If you don't see this output, please ensure that you've deactivated your pyenv or venv and don't have a global dbt version installed. Note that you no longer need to run the `dbt deps` command when your environment starts. This command was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file. From c3f50c96acbfc817f417882a1dac8de131d9c434 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 25 Oct 2023 10:32:18 +0100 Subject: [PATCH 08/14] rephrase --- .../docs/docs/cloud/cloud-cli-installation.md | 55 +++++++++++-------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 928c7240080..95962b0d8d9 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -19,7 +19,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * [Automatic deferral](/docs/cloud/about-cloud-develop-defer) 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. +https://github.com/dbt-labs/docs.getdbt.com/pull/4320* Significant platform improvements, to be released over the coming months. ## Prerequisites @@ -29,7 +29,9 @@ 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. For a step-by-step video guide, refer to the [FAQs](#faqs). +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). @@ -59,17 +61,17 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo brew install dbt ``` -3. To verify your installation, open the command line and run the command dbt --help. If your installation is correct, you should see the following output: - ```bash - The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud. For more documentation on these commands, visit: docs.getdbt.com - ``` - This output confirms that you've successfully installed the dbt Cloud CLI. If you don't see this output, please ensure that you've deactivated your pyenv or venv and don't have a global dbt version installed. - -Note that you no longer need to run the `dbt deps` command when your environment starts. This command was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file. +3. Verify your installation by running `dbt --help` in the command line. If you see the following output, your installation is correct + ```bash + The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... + ``` -7. 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 don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed. + + * 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. -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. +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. @@ -88,13 +90,17 @@ 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. - * 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. +3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct + ```bash + The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... + ``` -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. + If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed. + + * 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. -**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. +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. + * 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. @@ -117,13 +123,17 @@ 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. - * 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. +3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct + ```bash + The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... + ``` + + If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed. + + * 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. 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. - -**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. + * 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. @@ -186,8 +196,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`. ``` 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. - -**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. + * 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. From 7bd3568bc744eacb8aa0ffe56a5cb5a43f2b2f17 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 25 Oct 2023 10:37:31 +0100 Subject: [PATCH 09/14] fold in feedback --- 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 95962b0d8d9..b0207b62dad 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -100,7 +100,7 @@ Note that if you are using VS Code, you must restart it to pick up modified envi * 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. 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. - * 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. + * 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. @@ -133,7 +133,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa * 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. 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. - * 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. + * 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. @@ -196,7 +196,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`. ``` 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. - * 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. + * 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. From 7a38dbd9d9e5727faf7438635cfff391083e317d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 25 Oct 2023 10:39:20 +0100 Subject: [PATCH 10/14] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- 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 b0207b62dad..f0628e08ec5 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -195,7 +195,7 @@ 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. +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. From 3ca3da318b7e6b7e0e6c4a36885e8deb169e8c81 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 25 Oct 2023 10:41:34 +0100 Subject: [PATCH 11/14] add colon --- 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 b0207b62dad..698dc92df20 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -61,7 +61,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo brew install dbt ``` -3. Verify your installation by running `dbt --help` in the command line. If you see the following output, your installation is correct +3. Verify your installation by running `dbt --help` in the command line. If you see the following output, your installation is correct: ```bash The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... ``` @@ -90,7 +90,7 @@ 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 your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct +3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct: ```bash The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... ``` @@ -123,7 +123,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa ::: -3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct +3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct: ```bash The dbt Cloud CLI - an ELT tool for running SQL transformations and data models in dbt Cloud... ``` From 736868a95acb0bc15fb9ebb2cc209ffa5adc037b Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 25 Oct 2023 11:11:29 +0100 Subject: [PATCH 12/14] Update cloud-cli-installation.md folding privatelink/ssh per [slack thread](https://dbt-labs.slack.com/archives/C051TUB7S9W/p1698164950851459?thread_ts=1698149556.814129&cid=C051TUB7S9W) in this pr --- .../docs/docs/cloud/cloud-cli-installation.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index bd8be96a416..5816cff456e 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -25,13 +25,21 @@ https://github.com/dbt-labs/docs.getdbt.com/pull/4320* Significant platform impr ## Prerequisites The dbt Cloud CLI is available in all [deployment regions](/docs/cloud/about-cloud/regions-ip-addresses) and for both multi-tenant and single-tenant accounts (Azure single-tenant not supported at this time). -You must be on dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/dbt-versions/upgrade-core-in-cloud) to upgrade. +- Ensure you are using dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/dbt-versions/upgrade-core-in-cloud) to upgrade. +- Avoid using SSH tunneling for [Postgres and Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb) connections. +- Avoid using [PrivateLink](/cloud/secure/about-privatelink). ## Install dbt Cloud CLI 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). +
+Watch a step-by-step video guide +For a video walkthrough of the installation process, refer to the following video: + + + +
@@ -39,7 +47,6 @@ For a step-by-step video guide, refer to the [FAQs](#faqs). 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 you don't already have dbt Core installed: ```bash @@ -264,11 +271,4 @@ If you have dbt Core installed locally, either: You can always uninstall the dbt Cloud CLI to return to using dbt Core. -
-Are there any instructional videos to help guide me through installation? -For a video walkthrough of the installation process, refer to the following video: - - - -
From 54f5b142d44f6a2dfa6031f12412b500bcb19d5a Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 25 Oct 2023 11:20:27 +0100 Subject: [PATCH 13/14] tweak video callout --- website/docs/docs/cloud/cloud-cli-installation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 5816cff456e..5ce10b08355 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -34,8 +34,7 @@ The dbt Cloud CLI is available in all [deployment regions](/docs/cloud/about-clo You can install the dbt Cloud CLI on the command line by using one of these methods.
-Watch a step-by-step video guide -For a video walkthrough of the installation process, refer to the following video: +View a video tutorial for a step-by-step guide to installing From 504090fbbb006466e6b86338b037fce454fc2b0d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 25 Oct 2023 11:35:29 +0100 Subject: [PATCH 14/14] 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 5ce10b08355..3de2bbc694b 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -27,7 +27,7 @@ The dbt Cloud CLI is available in all [deployment regions](/docs/cloud/about-clo - Ensure you are using dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/dbt-versions/upgrade-core-in-cloud) to upgrade. - Avoid using SSH tunneling for [Postgres and Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb) connections. -- Avoid using [PrivateLink](/cloud/secure/about-privatelink). +- Avoid using [PrivateLink](/docs/cloud/secure/about-privatelink). ## Install dbt Cloud CLI