Quickstart¶

From nothing to a running platform in five steps.

1. Install the CLI¶

curl -sSL https://get.plasma.sh | sh

Prerequisites: Docker and Git. Runs on Linux, macOS, and Windows. See Install for details.

2. Scaffold a platform¶

plasmactl platform:create my-platform

This creates a platform with a platform.yaml (configuration constants) and a nodes/ directory (one file per machine).

3. Declare the packages you want¶

A platform composes one or more packages in compose.yaml:

name: my-platform
dependencies:
  - name: plasma-core
    source:
      type: git
      ref: main
      url: https://github.com/plasmash/plasma-core.git

4. Bring it up¶

plasmactl platform:up

platform:up runs the full workflow — bump → compose → prepare → deploy. Bringing real infrastructure up takes time, depending on what's being built — a simple application can be ~5 minutes, heavier ones longer, and a full platform can take hours. See Deploying.

5. See what you built¶

plasmactl platform:graph

The graph is the complete, authoritative picture of a platform — nodes, zone allocations, component distribution, and dependencies — in seconds. → Investigating a platform

Next: understand the model in Concepts, or learn to author components in Build.