From 55088ccf8bf1d701ec02fb1dddddd29c0e5ed2c8 Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Fri, 23 Aug 2024 13:09:46 -0700 Subject: [PATCH] Skip download of artifacts with dbt Cloud CLI (#5954) ## What are you changing in this pull request and why? For the dbt Cloud CLI, prevent artifact files from being downloaded by using `--download-artifacts=false` - Add new FAQ item to the Configure CLI page https://docs.getdbt.com/docs/cloud/configure-cloud-cli#faqs - Add new paragraph in this section https://docs.getdbt.com/reference/artifacts/dbt-artifacts#when-are-artifacts-produced ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] For [docs versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning), review how to [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content). - [ ] Needs review from PM --------- Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/cloud/configure-cloud-cli.md | 7 +++++++ website/docs/reference/artifacts/dbt-artifacts.md | 2 ++ 2 files changed, 9 insertions(+) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 2874e166a8f..854950f5d8c 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -189,3 +189,10 @@ move %USERPROFILE%\Downloads\dbt_cloud.yml %USERPROFILE%\.dbt\dbt_cloud.yml This command moves the `dbt_cloud.yml` from the `Downloads` folder to the `.dbt` folder. If your `dbt_cloud.yml` file is located elsewhere, adjust the path accordingly. + + + +By default, [all artifacts](/reference/artifacts/dbt-artifacts) are downloaded when you execute dbt commands from the dbt Cloud CLI. To skip these files from being downloaded, add `--download-artifacts=false` to the command you want to run. This can help improve run-time performance but might break workflows that depend on assets like the [manifest](/reference/artifacts/manifest-json). + + + \ No newline at end of file diff --git a/website/docs/reference/artifacts/dbt-artifacts.md b/website/docs/reference/artifacts/dbt-artifacts.md index 8d3e1ae29e8..c38cc2768e1 100644 --- a/website/docs/reference/artifacts/dbt-artifacts.md +++ b/website/docs/reference/artifacts/dbt-artifacts.md @@ -28,6 +28,8 @@ Most dbt commands (and corresponding RPC methods) produce artifacts: - [catalog](catalog-json): produced by `docs generate` - [sources](/reference/artifacts/sources-json): produced by `source freshness` +When running commands from the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), all artifacts are downloaded by default. If you want to change this behavior, refer to [How to skip artifacts from being downloaded](/docs/cloud/configure-cloud-cli#how-to-skip-artifacts-from-being-downloaded). + ## Where are artifacts produced? By default, artifacts are written to the `/target` directory of your dbt project. You can configure the location using the [`target-path` flag](/reference/global-configs/json-artifacts).