Start here¶

Outcome: You will (1) run a released plasm-server appliance or (2) from a plasm-core checkout validate a catalog and run one REPL query — then pick your next path.

Track A — Released appliance (recommended)¶

Install — plasm.tools/get → plasm-server
Boot — TTY → control station; scripts → --no-tui
Enable APIs + MCP key — control station APIs / Keys tabs (TUI guide) or plasm-server mcp …
Client — plasm init → plasm context → plasm run against the HTTP listener

Full walkthrough: Appliance quick start.

Track B — From source (catalog authors)¶

Prerequisites: Rust (cargo), repo cloned with apis/ populated.

Step 1 — Validate a catalog¶

cargo run -p plasm-cli --bin plasm -- schema validate apis/dnd5e

Verify: Exit code 0. The argument is the catalog directory (apis/<name>/), not domain.yaml alone.

Step 2 — REPL: one live read¶

cargo run -p plasm --bin plasm-repl -- \
  --schema apis/dnd5e \
  --backend https://www.dnd5eapi.co

Verify: Decoded rows at the repl> prompt (no transport errors).

Step 3 — Static CLI smoke (`plasm-cgs`)¶

cargo run -p plasm --bin plasm-cgs -- \
  --schema apis/pokeapi \
  --backend https://pokeapi.co \
  pokemon pikachu

Step 4 — Pack plugins and run the appliance¶

cargo run -p plasm --bin plasm-pack-plugins -- \
  --apis-root apis --output-dir target/plasm-plugins

cargo run -p plasm-server --release -- --plugin-dir target/plasm-plugins

Verify:

Check	Command
Health	`curl -sS http://127.0.0.1:3000/v1/health`
Registry	`curl -sS http://127.0.0.1:3000/v1/registry` lists multiple `entry_id`s

MCP Streamable HTTP is on the same host at /mcp (see Appliance quick start for Bearer keys).

Choose your next path¶

Goal	Go to
Install, TUI, MCP keys	Appliance quick start
`plasm init` / remote terminal	Remote terminal (`plasm`)
Credentials, OAuth vs PAT	MCP & credentials
Mental model	Concepts
Author catalogs	Catalog authoring
Optional incoming JWT	Incoming auth