Lampyr CLI
Lampyr CLI
The ly CLI creates, builds, publishes, deploys, and operates Lampyr Services.
| Command | Purpose |
|---|---|
ly scaffold | Create a Workspace or Lampyr Service. |
ly setup | Install the platform payload for this host. |
ly doctor | Check the platform and host prerequisites. |
ly dev | Run a service or multi-service workspace locally with Hyperlight snapshots. |
ly build | Build the snapshot and local OCI image. |
ly push | Push the local image to a registry. |
ly verify | Check local artifact metadata and digests. |
ly deploy | Deploy an immutable image Revision. |
ly status | Show service and Fiber status. |
ly logs | Read application-handler logs. |
ly audit | Read Fiber lifecycle audit records. |
ly scale | Change the active Revision’s Fiber limit. |
ly delete | Remove a deployed Lampyr Service. |
ly event | Publish an event with retries. |
ly cluster | Install and manage the platform. |
ly version | Print the CLI version. |
For the local worker spike, start with the multi-service workspace usage guide. It covers service bindings, HTTP and synchronous events, execution policy, and the source-checkout workflow.
Commands that operate on a project accept an optional project directory. They use the current directory when it is omitted.
Kubernetes operations use kubeconfig current-context unless --context NAME
selects an exact context. Merged KUBECONFIG files are supported; context names
are not expanded with kind- or aks- prefixes. Local commands do not require a
context. Build remains local unless --context selects a remote snapshot
builder. See ly cluster for cluster creation and reconciliation.
Command output
Installs, builds, pushes, and deployments show concise progress instead of raw
Docker, Kind, or kubectl logs. In an interactive terminal, a small fixed-position
spinner and elapsed timer indicate that each step is running. Completed steps
display ok. Redirected progress and CI use plain start/completion lines without
animation or ANSI codes.
Progress goes to stderr; command results stay on stdout.
Add --verbose before the project directory to stream underlying tool logs:
ly cluster install --verbose --provider kind --allow-dockerly build --verbose services/demo-apply push --verbose --image REGISTRY/demo-app:v1 services/demo-appFailed steps always report the underlying error and the last 64 KiB of captured
tool output, even without --verbose. Interactive application output from
ly dev and records from ly logs and ly audit are never hidden.
Set NO_COLOR to disable color, or TERM=dumb to disable animation as well.