@open-press/cli
CLI Overview
The CLI is organized into three levels — Lifecycle (daily build loop), Output targets (PDF / images / deploy), and Tools (utilities for agents and the workbench to use).
@open-press/cli provides a three-level command-line interface, responsible for managing workspace bootstrapping, build processes, and project maintenance.
Interface Stability Guarantee: Level 1 and Level 2 commands fall under the 1.0 stable contract specification. Level 3 tools are exclusively for use by the system, agents, and the workbench.
CLI Level Architecture
Level 1
Lifecycle
Covers daily build operations. Includes: create, dev, build, preview, typecheck.
Level 2
Output targets
Manages the generation of deliverables beyond standard HTML. Includes: openpress:pdf, openpress:image, and openpress:deploy.
Level 3
Tools
System maintenance and agent tools. Includes: search, replace, inspect, doctor, upgrade, and skills:sync.
API Reference Format
Each CLI command in this manual is documented using an API entry format:
- Basic Information: Includes command name, kind badge, invocation syntax, and a one-line summary.
- Parameter List: Itemizes all supported flags and properties.
- Examples: Standard usage scenario demonstrations.
Invocation syntax will contextually show the native open-press command or the npm run wrapper alias.