Overview

The Space CLI builds a SpaceOS system image, runs it on the local engine, and deploys it to a named target. It also publishes an application revision, re-checks the signed evidence on a delivered image, and prints a software bill of materials. It reports runtime status and reads workload logs.

Start here

Install the CLI from the Homebrew tap on the documentation home. Then work through the quickstart, which scaffolds a project and shows the build and boot commands that follow it.

The CLI reference carries every synopsis and option. Run space COMMAND --help=plain to print the help for one command.

Build and run locally

space init scaffolds a project from a named template. space build takes two inputs: your project’s files and the SpaceOS runtime image, pulled from a registry or taken from the local OCI cache. It composes them into one signed system image. space run boots that image through the local SpaceOS VM path.

Deliver a build

space publish mints one immutable marketplace revision from a signed build. space deploy assembles the per-board release and enqueues it for a connected target. The board, the device tree, and the secure-boot key belong to that target. space verify re-checks the signed evidence on a delivered image.

Observe a run

space status shows the workloads the runner supervises, each with a lifecycle state, an isolation backend, and an image digest. space logs displays workload logs.

Software bill of materials

space sbom prints the software bill of materials for a build. It scans the enumerated dependency closure against the OSV vulnerability database.

Where to go next

• The quickstart scaffolds a project and shows the build and boot commands.
• The CLI reference lists every command, option and exit status.
• Platform architecture explains the build and boot path.