Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cloud cli docs with windows, new instructions #4172

Merged
merged 140 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
140 commits
Select commit Hold shift + click to select a range
ba9c889
update cloud cli docs with windows, new instructions
greg-mckeon Oct 3, 2023
b811b55
Merge branch 'mwong-cloud-cli-beta' into cloud-cli-2
mirnawong1 Oct 3, 2023
f91cc4c
address review feedback
greg-mckeon Oct 3, 2023
df5cf97
updates
mirnawong1 Oct 3, 2023
8ee938e
Merge branch 'cloud-cli-2' of https://github.com/dbt-labs/docs.getdbt…
mirnawong1 Oct 3, 2023
df95165
fold in Greg's feedback
mirnawong1 Oct 3, 2023
79f153a
update to dbt-cloud
mirnawong1 Oct 3, 2023
bd637d8
Merge branch 'mwong-cloud-cli-beta' into cloud-cli-2
mirnawong1 Oct 4, 2023
72354fa
final tweaks
mirnawong1 Oct 4, 2023
67823e5
update numbers
mirnawong1 Oct 4, 2023
19cc4ce
add a next steps
mirnawong1 Oct 4, 2023
f67d8f2
add card
mirnawong1 Oct 4, 2023
48e2408
Merge branch 'mwong-cloud-cli-beta' into mwong-cloud-cli-links
mirnawong1 Oct 4, 2023
f9111b9
add overview page
mirnawong1 Oct 4, 2023
bda6e5d
add cloud cli to relevant pages
mirnawong1 Oct 4, 2023
cfd8ea1
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 4, 2023
95c7015
cloud cli updates
mirnawong1 Oct 4, 2023
2e6d1b2
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 4, 2023
c429896
update command page
mirnawong1 Oct 4, 2023
123437f
clarify language
mirnawong1 Oct 4, 2023
169f5e0
tweak language
mirnawong1 Oct 4, 2023
74b8ded
Merge branch 'mwong-cloud-cli-beta' into cloud-cli-2
mirnawong1 Oct 5, 2023
50035f2
add linux
mirnawong1 Oct 5, 2023
183619a
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 5, 2023
f9709be
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 5, 2023
96907de
update to pp
mirnawong1 Oct 5, 2023
c9d5da8
Merge branch 'cloud-cli-2' of https://github.com/dbt-labs/docs.getdbt…
mirnawong1 Oct 5, 2023
54a3b2f
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 5, 2023
b55c0fb
turn into tabs
mirnawong1 Oct 5, 2023
4f895d5
add defer page to cloud develop docs
dave-connors-3 Oct 5, 2023
f3fedc7
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 6, 2023
81c11a8
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 6, 2023
4cc2dc8
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
f36bed1
Update about-cloud-develop.md
mirnawong1 Oct 6, 2023
5cc4ccd
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
e28e84b
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 6, 2023
2c287c4
update commands
mirnawong1 Oct 6, 2023
b796849
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
ec99272
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 6, 2023
f849f29
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
533f1d6
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 6, 2023
0d5b0f7
Update website/docs/docs/core/about-the-cli.md
mirnawong1 Oct 6, 2023
7de8890
add dbt mesh
mirnawong1 Oct 6, 2023
6e0f27f
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
2074866
improve ux
mirnawong1 Oct 6, 2023
05876a8
Update website/docs/docs/cloud/cloud-cli-installation.md
greg-mckeon Oct 6, 2023
2da6f80
Update website/docs/docs/cloud/configure-cloud-cli.md
greg-mckeon Oct 6, 2023
4e1789b
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
84524ce
Update cloud-cli-installation.md
mirnawong1 Oct 9, 2023
fc0a3aa
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 9, 2023
3e567d0
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
b8de99a
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 9, 2023
224e839
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
9a399cb
update intro
mirnawong1 Oct 9, 2023
d0cc722
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 9, 2023
1852c42
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
5c052aa
Merge branch 'mwong-cloud-cli-links' into dc-defer-in-cloud
mirnawong1 Oct 9, 2023
c5f98e8
Update cloud-cli-installation.md
mirnawong1 Oct 9, 2023
01fd0e5
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 9, 2023
3d28be8
Update cloud-cli-installation.md
mirnawong1 Oct 9, 2023
c6be8e1
Merge branch 'mwong-cloud-cli-links' into dc-defer-in-cloud
mirnawong1 Oct 9, 2023
187b38f
add install feedback
greg-mckeon Oct 9, 2023
c55d27b
add credential file
greg-mckeon Oct 9, 2023
96a6ff1
Update website/docs/docs/about-setup.md
mirnawong1 Oct 10, 2023
f9a1cf1
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
814ac40
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
c123877
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 10, 2023
66c20e7
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 10, 2023
0b8abe5
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
4acf634
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
fc87678
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
14f0e4f
Update website/docs/docs/cloud/configure-cloud-cli.md
mirnawong1 Oct 10, 2023
c430b18
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
356d126
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
34c1442
Update about-cloud-develop.md
mirnawong1 Oct 10, 2023
1d9243a
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 10, 2023
62c9f6f
Update website/docs/docs/cloud/configure-cloud-cli.md
mirnawong1 Oct 10, 2023
43d57da
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
ac4ae6d
Update cloud-cli-installation.md
mirnawong1 Oct 10, 2023
4a1a75d
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 10, 2023
94562f5
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
a3753bb
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 10, 2023
e89e2d5
Update website/docs/docs/cloud/configure-cloud-cli.md
mirnawong1 Oct 10, 2023
27b57e3
Update website/docs/docs/cloud/configure-cloud-cli.md
mirnawong1 Oct 10, 2023
21b1db8
updates
mirnawong1 Oct 10, 2023
c42e2f9
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
112a29e
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 10, 2023
e2abba0
update pages and add redirect
mirnawong1 Oct 10, 2023
a71635a
Update website/docs/docs/cloud/about-cloud/dbt-cloud-features.md
mirnawong1 Oct 10, 2023
9408875
Update develop-in-the-cloud.md
mirnawong1 Oct 10, 2023
b8f678d
add cloud cli links (#4179)
mirnawong1 Oct 10, 2023
959222c
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 10, 2023
13a317e
update permissions
mirnawong1 Oct 10, 2023
a6c070e
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 10, 2023
9d585af
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 10, 2023
3aa2fd3
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 10, 2023
7bc788c
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 10, 2023
f764515
Update about-cloud-develop-defer.md
mirnawong1 Oct 10, 2023
faef573
Update about-cloud-develop-defer.md
mirnawong1 Oct 10, 2023
c061489
rename cli to core
mirnawong1 Oct 11, 2023
63168b2
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 11, 2023
04d6c32
fix broken links
mirnawong1 Oct 11, 2023
a06c5e3
Merge branch 'cloud-cli-2' of https://github.com/dbt-labs/docs.getdbt…
mirnawong1 Oct 11, 2023
ac9f38e
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 11, 2023
94ffe6e
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
868fb65
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
34ee784
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
39b43cf
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
e44e66b
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
b5628d3
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
56df191
Update about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
e5a3d66
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
aeb68f0
add defer screenshot
mirnawong1 Oct 11, 2023
02207fe
better pic
mirnawong1 Oct 11, 2023
f75a637
add venv step
mirnawong1 Oct 11, 2023
e21411c
Update configure-cloud-cli.md
mirnawong1 Oct 11, 2023
a31f454
Update website/docs/docs/cloud/about-cloud-develop-defer.md
mirnawong1 Oct 11, 2023
d4c2655
Merge branch 'cloud-cli-2' into dc-defer-in-cloud
mirnawong1 Oct 11, 2023
b696215
Update configure-cloud-cli.md
mirnawong1 Oct 11, 2023
e3e453f
Update cloud-cli-installation.md
mirnawong1 Oct 11, 2023
639cb71
add defer page to cloud develop docs (#4229)
mirnawong1 Oct 11, 2023
2cce94e
Update cloud-cli-installation.md
mirnawong1 Oct 11, 2023
4dc227c
update
mirnawong1 Oct 12, 2023
9b0ac9d
add
mirnawong1 Oct 12, 2023
ed9ba37
Merge branch 'cloud-cli-2' of https://github.com/dbt-labs/docs.getdbt…
mirnawong1 Oct 12, 2023
ff42542
Update cloud-cli-installation.md
mirnawong1 Oct 12, 2023
c84c760
Update cloud-cli-installation.md
mirnawong1 Oct 12, 2023
f22ad37
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 12, 2023
1cd2c05
Update cloud-cli-installation.md
greg-mckeon Oct 12, 2023
ccdc020
add config files
mirnawong1 Oct 12, 2023
5bf829d
Merge branch 'cloud-cli-2' of https://github.com/dbt-labs/docs.getdbt…
mirnawong1 Oct 12, 2023
39c1aa6
fix
mirnawong1 Oct 12, 2023
4baa72f
Update website/docs/docs/cloud/configure-cloud-cli.md
mirnawong1 Oct 12, 2023
d027ce9
Update configure-cloud-cli.md
mirnawong1 Oct 12, 2023
931f90e
Update cloud-cli-installation.md
mirnawong1 Oct 12, 2023
c1dfd09
Update cloud-cli-installation.md
mirnawong1 Oct 13, 2023
1f2af4a
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 13, 2023
c185c43
update quickstarts
mirnawong1 Oct 13, 2023
f413306
add tenant info
mirnawong1 Oct 13, 2023
91594f3
Merge branch 'mwong-mega-sl-clou-cli' into cloud-cli-2
mirnawong1 Oct 13, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions website/docs/docs/cloud/about-cloud-develop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: About developing in dbt Cloud
id: about-cloud-develop
description: "Learn how to develop your dbt projects using dbt Cloud."
sidebar_label: "About developing in dbt Cloud"
pagination_next: "docs/cloud/cloud-cli-installation"
---

dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI):
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

- **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** — Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment.

- Something to note is that the dbt Cloud CLI and the open-sourced dbt Core 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).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

- **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** — Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

This documentation section provides detailed instructions on setting up the dbt Cloud CLI and dbt Cloud IDE. To get started with dbt development, you'll need a [developer](/docs/cloud/manage-access/seats-and-users) account. For a more comprehensive setup guide, refer to our [quickstart guides](/quickstarts).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved



78 changes: 14 additions & 64 deletions website/docs/docs/cloud/cloud-cli-installation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: Installing the dbt Cloud CLI (Alpha)
title: Install dbt Cloud CLI
id: cloud-cli-installation
description: "Instructions for installing and configuring dbt Cloud CLI"
pagination_next: "docs/cloud/configure-cloud-cli"
---

:::warning Alpha functionality
:::info Public preview functionality
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

The following installation instructions are for the dbt Cloud CLI, currently in Alpha (actively in development and being tested).

These instructions are not intended for general audiences at this time.
The dbt Cloud CLI is currently in [public preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL).

:::

Expand All @@ -34,6 +33,7 @@ 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. If your operating system runs into path conflicts, refer to the [FAQs](#faqs).

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

1. Run the following command to verify that there is no conflict with a dbt Core installation on your system:

```bash
Expand All @@ -49,8 +49,7 @@ 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.
* You no longer need to use the `dbt deps` command. Previously, you had to run that command.

</TabItem>

Expand All @@ -70,8 +69,7 @@ Note that if you are using VS Code, you'll need to restart it to pick up modifie
:::
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

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.
* You no longer need to use the `dbt deps` command. Previously, you had to run that command.

</TabItem>

Expand All @@ -95,16 +93,16 @@ 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 no longer need to use the `dbt deps` command. Previously, you had to run that command.
* You no longer need to use the `dbt deps` command. Previously, you had to run that command.

</TabItem>

</Tabs>

## Update dbt Cloud CLI
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

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.


<Tabs>

Expand All @@ -121,65 +119,16 @@ To update, follow the same process explained in [Install manually (Windows)](/do

</Tabs>

## 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 command to compile a project using dbt Cloud:

```bash
dbt compile
```

**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
```
## Next steps

- In Powershell, add an environment variable:
- Note that this variable resets if you restart your shell. To add an environment variable permanently, add a system environment variable in your platform.
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 the following commands to compile a project using dbt Cloud:

3. Navigate to a dbt project in your terminal:

```bash
cd ~/dbt-projects/jaffle_shop
```

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.

```yaml
# dbt_project.yml
name:

version:
...

dbt-cloud:
project-id: PROJECT_ID
dbt compile
```

- 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`.


## Use the 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

<details>
Expand All @@ -198,3 +147,4 @@ If you have dbt Core installed locally, ensure that you deactivate your Python e
You can always uninstall the Cloud CLI to return to using dbt Core.
</details>


mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
65 changes: 65 additions & 0 deletions website/docs/docs/cloud/configure-cloud-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Configure dbt Cloud CLI
id: configure-cloud-cli
description: "Instructions on how to configure the dbt Cloud CLI"
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
---

:::info Public preview functionality
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

The dbt Cloud CLI is currently in [public preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL).

:::


## 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**.


## Configure the dbt Cloud CLI

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
```

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- In Powershell, add an environment variable: IS THIS MISSING SOMETHING?
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- 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
```

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.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

```yaml
# dbt_project.yml
name:

version:
...

dbt-cloud:
project-id: 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`.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved


## Use the 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.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

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.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
13 changes: 6 additions & 7 deletions website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
---
title: "Develop in the IDE"
title: "About the dbt Cloud IDE"
id: develop-in-the-cloud
description: "Develop, test, run, and build in the Cloud IDE. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly"
sidebar_label: Develop in the IDE
sidebar_label: About the IDE
tags: [IDE]
pagination_next: "docs/cloud/dbt-cloud-ide/ide-user-interface"
---

The dbt Cloud integrated development environment (IDE) is a single interface for building, testing, running, and version-controlling dbt projects from your browser. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly.

## Prerequisites

To develop in the Cloud IDE, make sure you have the following:

- A [dbt Cloud account](https://cloud.getdbt.com/) and [Developer seat license](/docs/cloud/manage-access/seats-and-users)
- A git repository set up and git provider must have `write` access enabled. See [Connecting your GitHub Account](/docs/cloud/git/connect-github) or [Importing a project by git URL](/docs/cloud/git/import-a-project-by-git-url) for detailed setup instructions
- A dbt project connected to a [data platform](/docs/cloud/connect-data-platform/about-connections)
Expand All @@ -24,9 +23,9 @@ To improve your experience using dbt Cloud, we suggest that you turn off ad bloc

:::

## Develop in the Cloud IDE
## Develop in the dbt Cloud IDE

The Cloud IDE is a powerful tool that can help streamline and govern your data platform development process. It offers a range of [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) that can help make your data platform development process faster and more efficient. Some of the editing features include:
The dbt Cloud IDE is a powerful tool that can help streamline and govern your data platform development process. It offers a range of [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) that can help make your data platform development process faster and more efficient. Some of the editing features include:

- The IDE has syntax highlighting for SQL. This makes it easy to visually distinguish between different parts of your code. This helps prevent syntax errors and improve readability.
- Use the IDE built-in auto-completion, which suggests table names, arguments, and column names as you type. This saves time and reduces the likelihood of typos or errors in your code.
Expand All @@ -38,7 +37,7 @@ All of these [features](#cloud-ide-features) work together to create a powerful

<Lightbox src="/img/docs/dbt-cloud/cloud-ide/ide-basic-layout.jpg" width="85%" title="The Cloud IDE layout includes version control on the upper left, files/folders on the left, editor on the right, and command/console at the bottom"/>

## Cloud IDE features
## dbt Cloud IDE features

The dbt Cloud IDE comes with [tips](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models.

Expand Down
38 changes: 25 additions & 13 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,26 +117,40 @@ const sidebarSettings = {
}, // Supported Git providers
{
type: "category",
label: "Develop in the IDE",
link: {
type: "doc",
id: "docs/cloud/dbt-cloud-ide/develop-in-the-cloud",
},
label: "Develop in dbt Cloud",
link: { type: "doc", id: "docs/cloud/about-cloud-develop" },
items: [
"docs/cloud/dbt-cloud-ide/ide-user-interface",
"docs/cloud/dbt-cloud-ide/lint-format",
"docs/cloud/dbt-cloud-ide/dbt-cloud-tips",
"docs/cloud/about-cloud-develop",
{
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
type: "category",
label: "dbt Cloud CLI (public preview)",
link: { type: "doc", id: "docs/cloud/cloud-cli-installation" },
items: [
"docs/cloud/cloud-cli-installation",
"docs/cloud/configure-cloud-cli",
],
},
{
type: "category",
label: "dbt Cloud IDE",
link: { type: "doc", id: "docs/cloud/dbt-cloud-ide/develop-in-the-cloud" },
items: [
"docs/cloud/dbt-cloud-ide/develop-in-the-cloud",
"docs/cloud/dbt-cloud-ide/ide-user-interface",
"docs/cloud/dbt-cloud-ide/lint-format",
"docs/cloud/dbt-cloud-ide/dbt-cloud-tips",
],
},
],
}, // dbt Cloud IDE directory
}, // dbt Cloud develop directory
{
type: "category",
label: "Secure your tenant",
items: [
"docs/cloud/secure/about-privatelink",
"docs/cloud/secure/snowflake-privatelink",
"docs/cloud/secure/databricks-privatelink",
"docs/cloud/secure/redshift-privatelink",
"docs/cloud/secure/postgres-privatelink",
"docs/cloud/secure/databricks-privatelink",
"docs/cloud/secure/ip-restrictions",
],
}, // PrivateLink
Expand Down Expand Up @@ -525,7 +539,6 @@ const sidebarSettings = {
link: { type: "doc", id: "docs/dbt-cloud-apis/sl-api-overview" },
items: [
"docs/dbt-cloud-apis/sl-jdbc",
"docs/dbt-cloud-apis/sl-graphql",
"docs/dbt-cloud-apis/sl-manifest",
],
},
Expand Down Expand Up @@ -1213,7 +1226,6 @@ const sidebarSettings = {
"community/resources/oss-expectations",
"community/resources/oss-projects",
"community/resources/contributor-license-agreements",
"community/resources/jobs-terms-and-conditions",
"community/resources/speaking-at-a-meetup",
],
},
Expand Down