Get started

Create a Lekko account

Go to the web UI (opens in a new tab) and sign up for an account. Lekko walks you through additional steps like setting up your organization with GitHub integration. Once you have an account, you can proceed with the next steps.

Initialize Lekko in your code repository

Run the following commands in your terminal to install the Lekko CLI:

brew tap lekkodev/lekko && brew install lekko

Run lekko init in the root of your project to initialize Lekko.

lekko init

This will:

• Create a .lekko file with basic configuration
• Add GitHub workflow to mirror lekko changes to Lekko
• Automatically install dependency libraries suitable for your project

Add Lekko build decorators

Lekko works by decorating (wrapping) your simple functions to make them lekkos during your build. At runtime, these decorated functions will fetch their latest value from Lekko when the LEKKO_API_KEY environment variable is set.

Use a new lekko in your code

Your project should have had a Lekko directory created with an example file (e.g. in src/lekko). Functions in files under this directory are lekkos and can be dynamically connected to Lekko’s services.

Try adding and changing lekkos here, following our SDK docs for your language/framework or the examples below.

Here are some ideas for basic lekkos for inspiration:

• A feature flag for conditionally rendering a component
• Text content for your landing page depending on the visitor's region
• Log level controller for your service based on the error message or HTTP code

package lekkoexample
 
// Return text based on environment
func getReturnText(env string) string {
    if env == "production" {
        return "foobar"
    } else if env == "development" {
        return "foo"
    }
    return "bar"
}

lekko bisync

package main
 
import (
    "context"
    "log"
    "net/http"
    "os"
 
    "example/lekko"
)
 
func main() {
    env := os.Getenv("ENV")
    client := lekko.NewLekkoClient(context.TODO())
    // Start a simple HTTP server on localhost:8080
    // You can send requests using `curl localhost:8080`
    addr := ":8080"
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte(client.Example.GetReturnText(env)))
    })
    log.Println("Listening on", addr)
    log.Fatal(http.ListenAndServe(addr, nil))
}

Generate a Lekko API key

For the next steps which involve connecting to Lekko's services, you need to generate an API key.

You can generate API keys on the web UI here (opens in a new tab).

Add Lekko API key to GitHub secret

For the Lekko GitHub Action to work correctly, you need to set LEKKO_API_KEY as a repository secret (opens in a new tab) on GitHub.

You can do this by going to your code repository on GitHub → Settings → Secrets and variables → Actions.

Open a pull request with your changes

With the lekko changes from the previous step, try opening a new pull request.

After all checks are completed, you should see a message like this:

Update a lekko remotely

Now to make lekkos dynamic at runtime, just set the LEKKO_API_KEY environment variable when building/running your project.

LEKKO_API_KEY=<API key> go run main.go

And make a change in the UI using our web UI at app.lekko.com (opens in a new tab). Here, you can track the history of your lekkos, manage team members, view the estimated impact of your changes, and more.

You should see the lekkos you set up in the earlier steps on your dashboard. Try making some changes and see how they affect your live project, without any redeployments!