OpenPress

@open-press/cli

CLI 總覽

CLI 被組織成三個層級 — 生命週期 (日常的建置循環)、輸出目標 (PDF / 圖片 / 部署)，以及工具 (給 agents 和 workbench 使用的實用程式)。

@open-press/cli 提供三層命令列介面，負責管理 workspace 啟動、建置流程與專案維護。

介面穩定性保證： 第一層與第二層指令屬於 1.0 穩定契約規範。第三層工具專供系統、agents 及 workbench 使用。

CLI 層級架構

第一層

生命週期 (Lifecycle)

涵蓋日常建置操作。包含：create、dev、build、preview、typecheck。

第二層

輸出目標 (Output targets)

管理標準 HTML 以外之交付物產出。包含：openpress:pdf、openpress:image 與 openpress:deploy。

第三層

工具 (Tools)

系統維護與代理工具。包含：search、replace、inspect、doctor、upgrade 與 skills:sync。

API 參考格式

本手冊中每個 CLI 指令皆採用 API 條目格式記錄：

  • 基本資訊：包含指令名稱、種類標籤、調用語法及單行摘要。
  • 參數列表：條列所有支援的旗標 (Flags) 及屬性。
  • 範例：標準使用情境示範。

調用語法會依據情境顯示原生的 open-press 指令或 npm run 封裝別名。