Skip to main content
Version: Next

Developer Setup


  • Docker v19.03.10+
  • Golang v1.19+
  • GNU Make- Mac (Preinstalled) - Windows: [Download]( - Ubuntu: `sudo apt-get install build-essential libssl-dev`

How to setup dev environment

The following guide will walk through how to run DevLake's frontend (config-ui) and backend in dev mode.

  1. Navigate to where you would like to install this project and clone the repository:

    git clone
    cd incubator-devlake
  2. Install dependencies for plugins:

  3. Install Go packages

    cd backend
    go get
    cd ..
  4. Copy the sample config file to new local file:

    cp env.example .env
  5. Update the following variables in the file .env:

    • DB_URL: Replace mysql:3306 with
  6. Start the MySQL and Grafana containers:

    Make sure the Docker daemon is running before this step.

    docker-compose -f docker-compose-dev.yml up -d mysql grafana
  7. Run devlake and config-ui in dev mode in two separate terminals:

    # specify the plugins that you need for both backend and frontend
    export DEVLAKE_PLUGINS=bamboo,bitbucket,circleci,customize,dora,gitextractor,github,github_graphql,gitlab,jenkins,jira,org,pagerduty,refdiff,slack,sonarqube,trello,webhook
    # install poetry, just follow the guide in:
    # run devlake
    make dev
    # run config-ui
    make configure-dev

    For common errors, please see Troubleshooting.

  8. Config UI is running at localhost:4000

    • For how to use Config UI, please refer to our tutorial

Running Tests

# install mockery
go install
# generate mocking stubs
make mock
# run tests
make test

DB migrations

Please refer to the Migration Doc.

Using DevLake API

All DevLake APIs (core service + plugin API) are documented with swagger. To see API doc live with swagger:

- Install [swag](
- Run `make swag` to generate the swagger documentation.
- Visit `http://localhost:8080/swagger/index.html` while `devlake` is running.

Developing dashboards

To access Grafana, click View Dashboards button in the top left corner of Config UI, or visit localhost:3002 (username: admin, password: admin).

For provisioning, customizing, and creating dashboards, please refer to our Grafana Doc.


Q: Running `make dev` yields error: ` cannot open share object file: No such file or directory`

A: `` is required by the gitextractor plugin and should be . Make sure your program can find ``. `LD_LIBRARY_PATH` can be assigned like this if your `` is located at `/usr/local/lib`:

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib

Note that the version has to be pinned to 1.3.0. If you don't have it, you may need to build it manually with CMake from [source](


- Compile all plugins: `make build-plugin`
- Compile specific plugins: `PLUGIN=<PLUGIN_NAME> make build-plugin`
- Compile server: `make build`
- Compile worker: `make build-worker`


To dig deeper into developing and utilizing our built-in functions and have a better developer experience, feel free to dive into our godoc reference.