Lunar CLI

Installing Lunar CLI

The Lunar CLI is primarily an administration tool for platform engineers, with developer-focused capabilities secondarily. It uses the same lunar binary as the CI agent but provides different subcommands for interactive CLI usage versus CI instrumentation. It can be used to manage configurations, inspect components, run collectors, and test policies.

Installation (Linux)

  1. Download the latest release:

    curl -LO https://github.com/earthly/lunar-dist/releases/download/v1.0.0/lunar-linux-amd64
  2. Move the binary to somewhere on your path and make it executable:

    sudo chmod +x lunar-linux-amd64 && mv ./lunar-linux-amd64 /usr/local/bin/lunar
  3. Verify installation:

    lunar --help
  4. Set required and optional environment variables:

    Some commands require a Hub instance & GitHub token. Add the following environmental variables to your shell profile.

    # Required
    export LUNAR_GITHUB_TOKEN=your_github_token
    export LUNAR_HUB_TOKEN=your_hub_token
    export LUNAR_HUB_HOST=your_hub_host
    export LUNAR_HUB_GRPC_PORT=your_grpc_port
    export LUNAR_HUB_HTTP_PORT=your_http_port

For usage examples and full CLI documentation, see the Lunar CLI Docs.


Next Steps

Once installed, you can begin configuring:

For questions or enterprise onboarding, contact the Earthly team.

Last updated