@open-press/cli 0.8.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # @open-press/cli
 
-Scaffolder for [open-press](https://github.com/quan0715/open-press) — an AI-first fixed-layout document workspace.
+Workspace CLI for [open-press](https://github.com/quan0715/open-press) — an AI-first fixed-layout document workspace.
 
 ## Prerequisite
 
@@ -9,13 +9,15 @@ Node.js 20 or newer with `npm` / `npx`.
 ## Quick start
 
 ```bash
-npx @open-press/cli init my-doc --pack editorial-monograph
+npx @open-press/cli init my-doc
 cd my-doc
 npm run dev
 ```
 
 Then open the local URL printed by Vite (typically `http://127.0.0.1:5173/?dev=1`).
 
+The CLI creates a package-based OpenPress workspace. Runtime files stay inside `@open-press/core`; your project keeps only source files, theme files, media, and npm scripts.
+
 ## Usage
 
 ```
@@ -24,40 +26,48 @@ npx @open-press/cli init <target> [flags]
 
 | Flag                 | Description                                                                 |
 | -------------------- | --------------------------------------------------------------------------- |
-| `--pack <name>`      | Style pack starter: `editorial-monograph`, `claude-document`, or `academic-paper` |
-| `--title <s>`        | Document title (written to `openpress.config.mjs`)                          |
-| `--subtitle <s>`     | Document subtitle                                                           |
-| `--organization <s>` | Organization name                                                           |
-| `--author <s>`       | Author name                                                                 |
-| `--no-git`           | Skip `git init`                                                             |
-| `--no-install`       | Skip `npm install`                                                          |
-| `--force`            | Allow scaffolding into a non-empty target                                   |
+| `--title <s>`        | Document title (written to workspace config)                                |
+| `--no-git`           | Skip `git init` + initial commit (use when scaffolding inside an existing repo) |
+| `--no-install`       | Skip `npm install` (offline, or you'll run pnpm/bun yourself)              |
+| `--skills`           | Install OpenPress agent skills after scaffolding                            |
+| `--no-skills`        | Skip agent skill installation                                               |
 | `--help`             | Print help                                                                  |
 
+> The target must be empty. A `.git/` directory or other harmless dotfiles (`.gitignore`, `.gitkeep`, `.DS_Store`) are ignored — common when scaffolding into a fresh repo.
+
+To use an opinionated starter, install a skill and let the agent copy that starter's `press/` files into the workspace:
+
+```bash
+npx -y skills@latest add quan0715/openpress-social-card-skill
+```
+
 ## What it creates
 
 A self-contained workspace with:
 
-- `engine/`, `src/`, `vite.config.ts` — the open-press framework (snapshot of `@open-press/core`)
-- `document/` — your content (populated from the chosen style pack)
-- `.claude/skills/` and `.agents/skills/` — agent skill files for Claude Code, Codex, Cursor, Copilot, etc.
-- `openpress.config.mjs` — workspace metadata (title, subtitle, organization, author)
-- `AGENTS.md` — agent contract
+- `package.json` with `@open-press/core`, `@open-press/cli`, and `open-press ...` scripts
+- `press/index.tsx` — the workspace document entry
+- `press/theme/`, `press/media/`, `press/components/` — user-owned authoring files
+- `press/design.md` — working design notes for agents and maintainers
+
+It does **not** create `engine/`, `src/openpress/`, `index.html`, or `vite.config.ts` in your project. Those are package-owned runtime internals.
 
 ## After init
 
-Workspace commands (run via `npm run` or `node engine/cli.mjs`):
+Workspace commands (run via `npm run` or `open-press`):
 
 ```
-npm run dev         # start workbench
-npm run openpress:export   # refresh public/openpress/document.json
-npm run build       # render production output (dist-react/)
-npm run preview     # preview production build
-npm run openpress:validate   # structural checks
-npm run openpress:pdf        # render PDF
-npm run openpress:deploy:dry-run
+npm run dev                       # start workbench
+npm run build                     # validate + render dist-react/
+npm run preview                   # preview production build
+npm run typecheck                 # tsc --noEmit
+npm run openpress:image           # render one PNG per page
+npm run openpress:pdf             # render PDF
+npm run openpress:deploy:dry-run  # preview deploy without publishing
 ```
 
+Full reference: <https://open-press.dev/docs/cli>
+
 ## License
 
 MIT — see [LICENSE](https://github.com/quan0715/open-press/blob/main/LICENSE).