Skip to content

Lampyr CLI

Lampyr CLI

The ly CLI creates, builds, publishes, deploys, and operates Lampyr Services.

CommandPurpose
ly scaffoldCreate a Workspace or Lampyr Service.
ly setupInstall the platform payload for this host.
ly doctorCheck the platform and host prerequisites.
ly devRun a service or multi-service workspace locally with Hyperlight snapshots.
ly buildBuild the snapshot and local OCI image.
ly pushPush the local image to a registry.
ly verifyCheck local artifact metadata and digests.
ly deployDeploy an immutable image Revision.
ly statusShow service and Fiber status.
ly logsRead application-handler logs.
ly auditRead Fiber lifecycle audit records.
ly scaleChange the active Revision’s Fiber limit.
ly deleteRemove a deployed Lampyr Service.
ly eventPublish an event with retries.
ly clusterInstall and manage the platform.
ly versionPrint 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:

Terminal window
ly cluster install --verbose --provider kind --allow-docker
ly build --verbose services/demo-app
ly push --verbose --image REGISTRY/demo-app:v1 services/demo-app

Failed 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.