Skip to main content

Install

From source

go install github.com/unveilr/unveilr-guard/cmd/unveilr@latest

Go 1.21 or later. The binary is self-contained and needs no runtime.

Verify

unveilr --version

Configuration

Everything works with no configuration. The environment variables below only matter if you connect the CLI to a control plane, which is optional and off unless you set them.

VariablePurposeDefault
UNVEILR_SAAS_URLControl-plane admin API base URLhttp://localhost:8080
UNVEILR_API_TOKENTenant-bound bearer or service tokenunset

unveilr status prints the resolved configuration and whether the control plane is reachable. With neither variable set, that is the expected and supported state — scan, repository inspection and proxy are entirely local.

What installing does not do

It does not start a daemon, add a shell hook, register a login item, or modify any agent's configuration. Nothing runs until you invoke the CLI, and proxy only sits in an agent's call path when you configure that agent to point at it.