Quick Start

The key steps to deploy and utilize Apache DevLake.

Step 1. Install DevLake

Install DevLake using either Docker Compose, Helm, or the gh-devlake CLI. If you want to upgrade DevLake to a newer version, please refer to the upgrade manuals.

Prefer the terminal? You can use gh-devlake, a GitHub CLI extension that deploys, configures, and monitors DevLake entirely from the command line:

gh extension install DevExpGBB/gh-devlake
gh devlake init

Step 2. Configure DevLake

Configure DevLake via the Config UI. Follow the tutorial for configuration instructions. If you specifically want to configure DORA metrics, please refer to the DORA manuals for detailed instructions.

Step 3. View Data in Grafana Dashboards

After configuring DevLake and collecting data, access the Config UI and click the "Dashboards" button in the top-right corner to view the data in Grafana dashboards. For comprehensive instructions, please refer to the Grafana manuals.