cli

module
v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2024 License: Apache-2.0

README

CLI

CLI Interface to the Lekko Dynamic Configuration Platform.

Documentation

Find our documentation at https://app.lekko.com/docs.

Download

To download lekko cli, you can use homebrew.

brew tap lekkodev/lekko
brew install lekko

Release

We use goreleaser (https://goreleaser.com/) to compile and release new versions of the lekko cli.

To install:

brew install goreleaser

To release, first export your Github access token to an environment variable. You can create a new GitHub token here.

export GITHUB_TOKEN="YOUR_GH_TOKEN"

Finally, create the release.

make release

This command will first prompt you for a new tag that it will push to GitHub. Then, it will cross-compile the binary for multiple platforms and architectures, using the latest tag on GitHub.

After completion, navigate to https://github.com/lekkodev/cli/releases/ to see the latest releases under the tag you just created.

Because the CLI repository is still private, the releaser is configured to publish the compiled assets to a public S3 bucket (lekko-cli-releases). The releaser is also responsible for generating/updating the homebrew formula for the lekkodev/lekko brew tap, which will download and install the CLI from that bucket.

Done! The cli has just been released. Follow instructions above to Download the latest cli.

Integration Tests

Integration tests exist for the cli and they are run on CI by default. You can run them locally:

GITHUB_TOKEN=${github_personal_access_token} make integration

The tests are configured to use the lekkodev/integration-test repository as a remote for testing.

All tests live in ./pkg/repo/repo_integration_test.go. They aren't run via make test due to the use of a Go Build Constraint.

Directories

Path Synopsis
cmd
pkg
fs
gen
Technically this file is specific to go, but the functions themselves are useful in general.
Technically this file is specific to go, but the functions themselves are useful in general.
gh
metadata
This package governs metadata in configuration repos and their surrounding development repositories as well.
This package governs metadata in configuration repos and their surrounding development repositories as well.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL