@open-press/cli
CLI overview
The CLI is organized in three tiers — Lifecycle (the everyday build loop), Output targets (PDF / deploy plus the image export Plan contract), and Tools (utilities for agents and the workbench).
OpenPress ships one public CLI: npx @open-press/cli init creates a workspace, and
open-press <command> (plus matching npm run scripts) runs everything
else from inside a workspace.
Surface stability. Tier 1 + Tier 2 commands are part of the 1.0 contract.
Tier 3 tools are implemented for agents and the workbench; treat their current names as the
draft contract until they are promoted into the main authoring loop.
Tier 1
Lifecycle
The everyday loop. init, dev, build, preview, typecheck — same shape as Vite or Astro.
Tier 2
Output targets
Producing artifacts other than the standard HTML bundle. openpress:pdf, openpress:deploy, and the openpress:image Plan contract.
Tier 3
Tools
Utilities for AI agents and the workbench — search, replace, inspect, doctor, upgrade, and skills:sync.
How to read each page
- Every command is rendered as an API entry with kind badge, invocation form, a one-line summary, a props table for flags, and an example.
-
Where a command's invocation differs between
open-pressand the bundlednpm runalias, the import line uses whichever form is more natural for that command. - Impl entries are callable today. Plan entries are draft contract shapes for the next implementation pass and should not be invoked as current commands.