@lobehub/cli 0.0.69 → 0.0.71

package/README.md

@@ -2,6 +2,50 @@
 
 LobeHub command-line interface.
 
+## Publish local artifacts
+
+```bash
+# Publish ordinary HTML and its referenced local resources
+lh artifact publish ./page.html --root . --json
+
+# Read the Canvas component and generation rules
+lh artifact guide canvas
+
+# Publish a self-contained Canvas HTML file
+lh artifact publish ./report.html --type canvas --json
+
+# The binding remembers the type; subsequent publishes update the same artifact
+lh artifact publish ./report.html --json
+
+# Create a separate Canvas and bind future publishes to it
+lh artifact publish ./report.html --new --json
+```
+
+Bindings and pending operations live in the project's `.lobehub/artifacts.json`.
+Retry the same command with unchanged input after a failed Canvas save or publish;
+the CLI resumes that operation without creating another Canvas or saved version.
+Restore the original input before retrying if you edited it during recovery.
+An explicit validation or version-conflict rejection releases the pending save,
+so you can correct the file or inspect the latest version before trying again.
+If publication explicitly rejects a slug, correct `--slug` and retry with the same
+content and target; the CLI reuses the saved Canvas and version.
+Canvas bindings are scoped to the authenticated account, server and workspace.
+
+Canvas input is a single HTML file with inline styles, scripts and data, subject
+to the Canvas guide's validation and size limits. Publication saves a version in
+LobeHub and returns a public URL; it requires a server with Canvas publishing and
+a compatible runtime. JSON errors retain any saved Canvas ID and version.
+
+`--slug <name>` requests the readable prefix for a new deployment. Market adds an
+eight-character suffix; both HTML and Canvas use the same rule. Existing deployments
+retain their address when updated, including older records without a stored label.
+JSON `publicUrl` is the direct hosting URL; `shareUrl` is the LobeHub product share
+page, and `subdomainLabel` is the actual assigned label when the server returns it.
+
+`--deployment <id>` overrides the deployment for this run without changing the
+canonical binding. `--new` and `--deployment` cannot be combined. Changing an
+existing artifact's content type requires `--new`.
+
 ## Acceptance skill
 
 The acceptance skill is maintained in [lobehub/acceptance](https://github.com/lobehub/acceptance).
@@ -17,8 +61,8 @@ Update the installed skill:
 lh acceptance update
 ```
 
-Creating acceptances and publishing reports require authentication. Run `lh login`
-before using those commands.
+Publishing reports to LobeHub requires authentication (`lh login`). Without a
+login, acceptance runs locally — see [Local reports](#local-reports).
 
 This selects the same source as `npx skills add lobehub/acceptance --skill acceptance`.
 Changes merged into the default branch are available on the next install or
@@ -40,6 +84,31 @@ To select an existing version tag explicitly, use `lh acceptance update --skill-
 with `npx skills add`. A later `lh acceptance update` without `--skill-version`
 returns to the current default-branch source.
 
+## Local reports
+
+A machine that has never signed in renders acceptance reports locally instead
+of publishing them; `lh acceptance preflight --json` reports `"mode": "local"`.
+
+```bash
+lh acceptance run render .acceptances/<subject>/<round> --requirement "<business goal>"
+```
+
+This writes `report.html` beside the rounds: the acceptance page, offline — the
+checklist, evidence, before/after pairs, video chapters and round history,
+rendered from every round of that acceptance. Nothing is uploaded. The reader
+can accept or reject checks and circle regions on screenshots there; **Save
+reviews** downloads the decisions, and the next
+`lh acceptance feedback .acceptances/<subject>` (or `view`) files them as
+`reviews.json` and reports them like hosted feedback.
+
+Comments, mentions and shared links need LobeHub. After `lh login`,
+`lh acceptance publish .acceptances/<subject>` publishes the unpublished rounds
+in order into one acceptance and carries the standing review decisions over;
+running it again publishes only newer rounds.
+
+The page is built by `apps/workbench` (`bun run --cwd ../workbench build:report`);
+`bun run build` copies it to `dist/acceptance-report.html` when it exists.
+
 ## Local Development
 
 | Task                                       | Command                    |
@@ -49,7 +118,7 @@ returns to the current default-branch source.
 | Link `lh`/`lobe`/`lobehub` into your shell | `bun run cli:link`         |
 | Remove the global link                     | `bun run cli:unlink`       |
 
-- `bun run build` only generates `dist/index.js`.
+- `bun run build` generates `dist/index.js`, plus `dist/acceptance-report.html` when the local report page is built.
 - To make `lh` available in your shell, run `bun run cli:link`.
 - After linking, if your shell still cannot find `lh`, run `rehash` in `zsh`.