Skip to content

Commit 74f5622

Browse files
owlasmintlify[bot]
andauthored
Add CLI documentation for config list-projects and get-project commands (#369)
* Update references/lightdash-cli.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/lightdash-cli.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 92d7ea8 commit 74f5622

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

references/lightdash-cli.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ For examples and command-specific options, click through the command in the tabl
9292
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
9393
|[`lightdash login`](/references/lightdash-cli#lightdash-login) | Log in to a Lightdash instance using email/password or a token |
9494
|[`lightdash config set-project`](/references/lightdash-cli#lightdash-config-set-project) | Choose or set the Lightdash project you are working on |
95+
|[`lightdash config get-project`](/references/lightdash-cli#lightdash-config-get-project) | Get the current active project |
96+
|[`lightdash config list-projects`](/references/lightdash-cli#lightdash-config-list-projects) | List all non-preview projects in your organization |
9597
|[`lightdash compile`](/references/lightdash-cli#lightdash-compile) | Compile lightdash resources using your local project files |
9698
|[`lightdash preview`](/references/lightdash-cli#lightdash-preview) | Create a temporary preview project, then wait for a keypress to stop |
9799
|[`lightdash start-preview`](/references/lightdash-cli#lightdash-start-preview) | Create a preview project that stays open until it is stopped |
@@ -186,6 +188,26 @@ Set project to the one with this UUID:
186188
lightdash config set-project --uuid "d75379bc-f6e9-4e52-86b2-d897cabacd0c"
187189
```
188190

191+
### `lightdash config get-project`
192+
193+
Get the current active project that the CLI is configured to use.
194+
195+
```bash
196+
lightdash config get-project
197+
```
198+
199+
This command displays the project that is currently set for CLI operations. Use this to verify which project will be affected by commands like `lightdash validate`, `lightdash preview`, and `lightdash deploy`.
200+
201+
### `lightdash config list-projects`
202+
203+
List all non-preview projects in your organization.
204+
205+
```bash
206+
lightdash config list-projects
207+
```
208+
209+
This command displays all available projects (excluding preview projects) that you can select using `lightdash config set-project`.
210+
189211
### `lightdash compile`
190212

191213
Compile Lightdash resources using your local project and database credentials. dbt gets compiled first, then your Lightdash explores. If you use [dbt node selection](#dbt-node-selection) to only compile a subset of models, Lightdash will also compile models joined to those models to ensure no field references are broken.

0 commit comments

Comments
 (0)