Skip to content
Open
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions references/lightdash-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ For examples and command-specific options, click through the command in the tabl
|[`lightdash login`](/references/lightdash-cli#lightdash-login) | Log in to a Lightdash instance using email/password or a token |
|[`lightdash config set-project`](/references/lightdash-cli#lightdash-config-set-project) | Choose or set the Lightdash project you are working on |
|[`lightdash config get-project`](/references/lightdash-cli#lightdash-config-get-project) | Get the current active project |
|[`lightdash config rename-project`](/references/lightdash-cli#lightdash-config-rename-project) | Rename the currently selected project |
|[`lightdash config list-projects`](/references/lightdash-cli#lightdash-config-list-projects) | List all non-preview projects in your organization |
|[`lightdash compile`](/references/lightdash-cli#lightdash-compile) | Compile lightdash resources using your local project files |
|[`lightdash preview`](/references/lightdash-cli#lightdash-preview) | Create a temporary preview project, then wait for a keypress to stop |
Expand Down Expand Up @@ -222,6 +223,38 @@ lightdash config get-project

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

### `lightdash config rename-project`

Rename the currently selected project. This updates the project name in Lightdash and also refreshes your local CLI context so subsequent commands use the new name.

```bash
lightdash config rename-project --name "<new name>"
```

Use this after selecting a project with [`lightdash config set-project`](#lightdash-config-set-project) when you want to change the display name without leaving the CLI. Check the current selection first with [`lightdash config get-project`](#lightdash-config-get-project).

This command only changes the project name. It does not modify warehouse connection settings or dbt configuration, and it does not trigger a recompile.

**Options:**

- `--name <name>` (required)
- The new name for the selected project

**Requirements:**

- A project must already be selected via `lightdash config set-project`.
- Your user must have a role with permission to update project details.

**Example:**

Rename the currently selected project to "Analytics":

```bash
lightdash config rename-project --name "Analytics"
```

On success, the CLI prints a confirmation with the new project name.

### `lightdash config list-projects`

List all non-preview projects in your organization.
Expand Down
Loading