Reference

Reference material is information-oriented: exhaustive and normative. When you need to know exactly what a field means or what a command does, this is the section to consult.

Specifications

The normative specifications live in the repository and are versioned alongside the manifest:

• Manifest specification: every section, resource kind and interpolation rule.
• Control plane API: the local HTTP API the dashboard and the client commands speak.
• Observability: the bundled OpenTelemetry collector and the metrics it exposes.
• Export: how the manifest maps to each deployment target.

A JSON Schema for editor autocompletion ships at docs/spec/manifest-v0.schema.json.

API documentation

The Rust API of every published crate is documented on docs.rs:

• lightshuttle (the CLI)
• lightshuttle-manifest
• lightshuttle-spec
• lightshuttle-runtime
• lightshuttle-otel
• lightshuttle-control
• lightshuttle-secrets
• lightshuttle-export

The manifest reference is generated from the JSON Schema and documents every top-level section and resource kind. The CLI reference is generated from the command definitions and documents every subcommand, its flags and examples.