cloud cli updates (#4354)

this pr updates cloud cli doc adn command line docs: - clarifies the installation instructions for existing core users. this includes structuring the considerations. - adds an 'extensions' header . this needs more info on why certain extensions aren't support inthe cloud cli - updates the commands page so that debug is available to all tools in 1.6+, updates the clone command is available in ide. - adds add'l context in clone command page on how to use in the ide. ## requirements [ ] Needs PM review (greg) [ ] Needs SME review (dave connors)
dbt-labs · Nov 8, 2023 · ca0ffa6 · ca0ffa6
2 parents a616dd7 + 4d194ca
commit ca0ffa6
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 51 deletions.
diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md
@@ -26,15 +26,14 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from:
 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).
 
 - 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](/docs/cloud/secure/about-privatelink).
+- Note that SSH tunneling for [Postgres and Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb) connections and [Single sign-on (SSO)](/docs/cloud/manage-access/sso-overview) doesn't support the dbt Cloud CLI yet.
 
 ## Install dbt Cloud CLI
 
 You can install the dbt Cloud CLI on the command line by using one of these methods. 
 
 <details>
-<summary>View a video tutorial for a step-by-step guide to installing</summary>
+<summary>View a video tutorial for a step-by-step guide to installation.</summary>
 
 <LoomVideo id="dd80828306c5432a996d4580135041b6?sid=fe1895b7-1281-4e42-9968-5f7d11768000"/>
 
@@ -44,28 +43,26 @@ You can install the dbt Cloud CLI on the command line by using one of these meth
 
 <TabItem value="brew" label="macOS (brew)">
 
-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.
+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:
+1. 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 remove dbt Core from your machine. <br />
+   - If you see a `dbt not found`, you're good to go. If the dbt help text appears, use `pip uninstall dbt` to remove dbt Core from your system. <br />
 
 2. Install the dbt Cloud CLI with Homebrew: 
 
    - 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:
+   -  Then, 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
       ```
+      If you have multiple taps, use `brew install dbt-labs/dbt-cli/dbt`.
 
 3. Verify your installation by running `dbt --help` in the command line. If you see the following output, your installation is correct:
       ```bash
@@ -77,7 +74,7 @@ Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in yo
    * 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 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>
 
@@ -106,7 +103,6 @@ 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 locally on your machine. 
 
 </TabItem>
 
@@ -139,49 +135,50 @@ 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 locally on your machine.
 
 </TabItem>
 
 <TabItem value="pip" label="Existing dbt Core users (pip)">
 
+If you already have dbt Core installed, the dbt Cloud CLI may conflict. Here are some considerations:
 
-:::info Use native packages or a virtual environment to prevent dbt Core conflicts
-
-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.
-:::
+- **Prevent conflicts** <br /> Use both the dbt Cloud CLI and dbt Core with `pip` and create a new virtual environment.<br /><br />
+- **Use both dbt Cloud CLI and dbt Core with brew or native installs** <br /> If you use Homebrew, consider aliasing the dbt Cloud CLI as "dbt-cloud" to avoid conflict. For more details, check the [FAQs](#faqs) if your operating system experiences path conflicts.<br /><br />
+- **Reverting back to dbt Core from the dbt Cloud CLI** <br />
+  If you've already installed the dbt Cloud CLI and need to switch back to dbt Core:<br />
+  - Uninstall the dbt Cloud CLI using the command: `pip uninstall dbt`
+  - Reinstall dbt Core using the following command, replacing "adapter_name" with the appropriate adapter name:
+    ```shell
+    pip install dbt-adapter_name --force-reinstall
+    ```
+    For example, if I used Snowflake as an adapter, I would run: `pip install dbt-snowflake --force-reinstall`
 
+--------
 
 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`.
 
-1. Create a new venv:
+1. Create a new virtual environment named "dbt-cloud" with this command:
    ```shell
    python3 -m venv dbt-cloud
     ```
 
-2. Activate the virtual environment each time you create a shell window or session:
-  ```shell   
-  source dbt-cloud/bin/activate         # activate the environment for Mac and Linux OR
-  dbt-env\Scripts\activate            # activate the environment for Windows
-  ```
+2. Activate the virtual environment each time you create a shell window or session, depending on your operating system:
 
-3. (Mac and Linux only) Create an alias to activate your dbt environment with every new shell window or session. You can add the following to your shell's configuration file (for example, $HOME/.bashrc, $HOME/.zshrc) while replacing `<PATH_TO_VIRTUAL_ENV_CONFIG>` with the path to your virtual environment configuration:
+   - For Mac and Linux, use: `source dbt-cloud/bin/activate`<br/>
+   - For Windows, use: `dbt-env\Scripts\activate` 
+
+3. (Mac and Linux only) Create an alias to activate your dbt environment with every new shell window or session. You can add the following to your shell's configuration file (for example, `$HOME/.bashrc, $HOME/.zshrc`) while replacing `<PATH_TO_VIRTUAL_ENV_CONFIG>` with the path to your virtual environment configuration:
    ```shell
    alias env_dbt='source <PATH_TO_VIRTUAL_ENV_CONFIG>/bin/activate'
    ```
-   
+
 ### Install dbt Cloud CLI in pip
 
-1. (Optional) If you already have dbt Core installed, this installation will override that package. Note your dbt Core version in case you need to reinstall it later:
+1. (Optional) If you already have dbt Core installed, this installation will override that package. Check your dbt Core version in case you need to reinstall it later by running the following command :
 
   ```bash
   dbt --version
@@ -193,25 +190,23 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`.
   pip3 install dbt
   ```
 
-3. (Optional) To revert back to dbt Core, first uninstall both the dbt Cloud CLI and dbt Core
-4. Reinstall dbt Core using the version from Step 2.
+1. (Optional) To revert back to dbt Core, first uninstall both the dbt Cloud CLI and dbt Core. Then reinstall dbt Core.
 
   ```bash
   pip3 uninstall dbt-core dbt
-  pip3 install dbt-core==VERSION
+  pip install dbt-adapter_name --force-reinstall
   ```
 
-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. 
+4. After you've verified the installation, [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project. You can then 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.
 
 </TabItem>
 
-</Tabs>
 
+</Tabs>
 
 ## Update dbt Cloud CLI
 
-The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. 
+The following instructions explain how to update the dbt Cloud CLI to the latest version depending on your operating system. 
 
 During the public preview period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes.
 
@@ -246,6 +241,13 @@ To update:
 
 </Tabs>
 
+## Using VS Code extensions
+
+Visual Studio (VS) Code extensions enhance command line tools by adding extra functionalities. The dbt Cloud CLI is fully compatible with dbt Core, however it doesn't support some dbt Core APIs required by certain tools, for example VS Code extensions. 
+
+To use these extensions, such as dbt-power-user, with the dbt Cloud CLI, you can install it using Homebrew (along with dbt Core) and create an alias to run the dbt Cloud CLI as `dbt-cloud`. This allows dbt-power-user to continue to invoke dbt Core under the hood, alongside the dbt Cloud CLI.
+
+
 ## FAQs
 
 <details>
@@ -257,19 +259,38 @@ The dbt Cloud CLI and <a href="https://github.com/dbt-labs/dbt-core">dbt Core</a
 
 <details>
 <summary>How do I run both the dbt Cloud CLI and dbt Core?</summary>
-For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running <code>dbt</code>. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings).
+For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running <code>dbt</code>. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings).<br />
 
 If you have dbt Core installed locally, either:
 
-1. Install using [pip](/docs/cloud/cloud-cli-installation?install=pip#install-dbt-cloud-cli).
-
-2. Install natively, but ensure that you deactivate your Python environment or uninstall it using `pip uninstall dbt` before proceeding.  
-
+1. Install using the <code>pip3 install dbt</code> [pip](/docs/cloud/cloud-cli-installation?install=pip#install-dbt-cloud-cli) command.
+2. Install natively, ensuring you either deactivate the virtual environment containing dbt Core or create an alias for the dbt Cloud CLI. 
 3. (Advanced users) Install natively, but modify the $PATH environment variable to correctly point to the dbt Cloud CLI binary to use both dbt Cloud CLI and dbt Core together.
 
 You can always uninstall the dbt Cloud CLI to return to using dbt Core.
 </details>
 
+<details>
+<summary>How to create an alias?</summary>
+To create an alias for the dbt Cloud CLI: <br />
+
+1. Open your shell's profile configuration file. Depending on your shell and system, this could be <code>~/.bashrc</code>, <code>~/.bash_profile</code>, <code>~/.zshrc</code>, or another file.<br />
+
+2. Add an alias that points to the dbt Cloud CLI binary. For example:<code>alias dbt-cloud="path_to_dbt_cloud_cli_binary</code>
+   
+   Replace <code>path_to_dbt_cloud_cli_binary</code> with the actual path to the dbt Cloud CLI binary, which is <code>/opt/homebrew/bin/dbt</code>. With this alias, you can use the command <code>dbt-cloud</code> to invoke the dbt Cloud CLI.<br />
+
+3. Save the file and then either restart your shell or run <code>source</code> on the profile file to apply the changes.
+As an example, in bash you would run: <code>source ~/.bashrc</code><br />
+
+1. Test and use the alias to run commands:<br />
+   - To run the dbt Cloud CLI, use the <code>dbt-cloud</code> command: <code>dbt-cloud command_name</code>. Replace 'command_name' with the specific dbt command you want to execute.<br />
+   - To run the dbt Core, use the <code>dbt</code> command: <code>dbt command_name</code>. Replace 'command_name' with the specific dbt command you want to execute.<br />
+
+
+This alias will allow you to use the <code>dbt-cloud</code> command to invoke the dbt Cloud CLI while having dbt Core installed natively.
+</details>
+
 <details>
 <summary>Why am I receiving a <code>Session occupied</code> error?</summary>
 If you've ran a dbt command and receive a <code>Session occupied</code> error, you can reattach to your existing session with <code>dbt reattach</code> and then press <code>Control-C</code> and choose to cancel the invocation.

diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md
@@ -14,7 +14,7 @@ import CloudCLIFlag from '/snippets/_cloud-cli-flag.md';
 ## Prerequisites
 
 - You must set up a project in dbt Cloud.
-  - **Note** &mdash; 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. 
+  - **Note** &mdash; If you're using the dbt Cloud CLI, you can connect to your [data platform](/docs/cloud/connect-data-platform/about-connections) directly in the dbt Cloud interface and don't need a [`profiles.yml`](/docs/core/connect-data-platform/profiles.yml) file. 
 - 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 be on dbt version 1.5 or higher. Refer to [dbt Cloud versions](/docs/dbt-versions/upgrade-core-in-cloud) to upgrade.
 
@@ -87,10 +87,10 @@ To set environment variables in the dbt Cloud CLI for your dbt project:
 
 ## Use the dbt Cloud CLI
 
-- The dbt Cloud CLI shares the same set of [dbt commands](/reference/dbt-commands) as dbt Core and processes the commands you invoke. 
-- It allows you to use automatic deferral of build artifacts to your Cloud project's production environment.
+- The dbt Cloud CLI uses the same set of [dbt commands](/reference/dbt-commands) and [MetricFlow commands](/docs/build/metricflow-commands) as dbt Core to execute the commands you provide.
+- It allows you to automatically defer build artifacts to your Cloud project's production environment.
 - It also supports [project dependencies](/docs/collaborate/govern/project-dependencies), which allows you to depend on another project using the metadata service in dbt Cloud. 
-  - Project dependencies instantly connect to and reference (or  `ref`) public models defined in other projects. This means you don't need to execute or analyze these upstream models yourself. Instead, you treat them as an API that returns a dataset.
+  - Project dependencies instantly connect to and reference (or  `ref`) 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.
 
 :::tip Use the <code>--help</code> flag
 As a tip, most command-line tools have a `--help` flag to show available commands and arguments. Use the `--help` flag with dbt in two ways:

diff --git a/website/docs/reference/commands/clone.md b/website/docs/reference/commands/clone.md
@@ -16,6 +16,7 @@ The `clone` command is useful for:
 - handling incremental models in dbt Cloud CI jobs (on data warehouses that support zero-copy cloning tables)
 - testing code changes on downstream dependencies in your BI tool
 
+
 ```bash
 # clone all of my models from specified state to my target schema(s)
 dbt clone --state path/to/artifacts
@@ -38,4 +39,18 @@ For example, by creating actual data warehouse objects, `dbt clone` allows you t
 
 As another example, you could `clone` your modified incremental models as the first step of your dbt Cloud CI job to prevent costly `full-refresh` builds for warehouses that support zero-copy cloning.
 
+## Cloning in dbt Cloud
+
+You can clone nodes between states in dbt Cloud using the `dbt clone` command. This is available in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) and the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) and  relies on the [`--defer`](/reference/node-selection/defer) feature. For more details on defer in dbt Cloud, read [Using defer in dbt Cloud](/docs/cloud/about-cloud-develop-defer).
+
+- **Using dbt Cloud CLI** &mdash; The `dbt clone` command in the dbt Cloud CLI automatically includes the `--defer` flag. This means you can use the `dbt clone` command without any additional setup.
+
+- **Using dbt Cloud IDE** &mdash; To use the `dbt clone` command in the dbt Cloud IDE, follow these steps before running the `dbt clone` command:
+
+  - Set up your **Production environment** and have a successful job run.
+  - Enable **Defer to production** by toggling the switch in the lower-right corner of the command bar.
+    <Lightbox src="/img/docs/dbt-cloud/defer-toggle.jpg" width="80%" title="Select the 'Defer to production' toggle on the bottom right of the command bar to enable defer in the dbt Cloud IDE."/>
+  - Run the `dbt clone` command from the command bar.
+
+
 Check out [this Developer blog post](https://docs.getdbt.com/blog/to-defer-or-to-clone) for more details on best practices when to use `dbt clone` vs. deferral.