Skip to content

docs: add gh-devlake CLI to QuickStart as alternative installation method #820

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.

Sign up for GitHub

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

Merged
klesh merged 1 commit into from
Mar 2, 2026
Merged

docs: add gh-devlake CLI to QuickStart as alternative installation method #820

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion docs/GettingStarted/QuickStart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ sidebar_position: 1
The key steps to deploy and utilize Apache DevLake.

## Step 1. Install DevLake
Install DevLake using either <a href="DockerComposeSetup">Docker Compose</a> or <a href="HelmSetup">Helm</a>. If you want to upgrade DevLake to a newer version, please refer to the <a href="Upgrade">upgrade manuals</a>.
Install DevLake using either <a href="DockerComposeSetup">Docker Compose</a>, <a href="HelmSetup">Helm</a>, or the <a href="https://github.com/DevExpGBB/gh-devlake">gh-devlake CLI</a>. If you want to upgrade DevLake to a newer version, please refer to the <a href="Upgrade">upgrade manuals</a>.

**Prefer the terminal?** You can use [gh-devlake](https://github.com/DevExpGBB/gh-devlake), a GitHub CLI extension that deploys, configures, and monitors DevLake entirely from the command line:

```bash
gh extension install DevExpGBB/gh-devlake
gh devlake init
```

## Step 2. Configure DevLake
Configure DevLake via the Config UI. Follow the <a href="/docs/Configuration/Tutorial">tutorial</a> for configuration instructions. If you specifically want to configure DORA metrics, please refer to the <a href="/docs/DORA">DORA manuals</a> for detailed instructions.
Expand Down