You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2026/03/02 13:20:07 UTC

(incubator-devlake-website) branch main updated: docs: add gh-devlake CLI to QuickStart as alternative installation method (#820)

This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git


The following commit(s) were added to refs/heads/main by this push:
     new a5bb599c9bc docs: add gh-devlake CLI to QuickStart as alternative installation method (#820)
a5bb599c9bc is described below

commit a5bb599c9bcdb892874db8b525ef9820baf6aba7
Author: Eldrick Wega <el...@outlook.com>
AuthorDate: Mon Mar 2 16:20:01 2026 +0300

    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
---
 docs/GettingStarted/QuickStart.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/docs/GettingStarted/QuickStart.md b/docs/GettingStarted/QuickStart.md
index 8132196b641..e27e91917f5 100644
--- a/docs/GettingStarted/QuickStart.md
+++ b/docs/GettingStarted/QuickStart.md
@@ -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.