Skip to content

Commit a5bb599

Browse files
authored
docs: add gh-devlake CLI to QuickStart as alternative installation method (#820)
Adds gh-devlake as a third installation option in Step 1 alongside Docker Compose and Helm, with a brief install snippet. Related: apache/incubator-devlake#8732
1 parent 3079a2b commit a5bb599

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/GettingStarted/QuickStart.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ sidebar_position: 1
88
The key steps to deploy and utilize Apache DevLake.
99

1010
## Step 1. Install DevLake
11-
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>.
11+
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>.
12+
13+
**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:
14+
15+
```bash
16+
gh extension install DevExpGBB/gh-devlake
17+
gh devlake init
18+
```
1219

1320
## Step 2. Configure DevLake
1421
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.

0 commit comments

Comments
 (0)