tldr-review
v0.2.0
Published
TLDR, a local-first human review and reading workspace for structured artifacts. Provides the tldr binary.
Maintainers
Readme
tldr-review
tldr-review is the npm package name. It owns the tldr command-line surface defined by section 27.2 of docs/architecture.md.
Every non-interactive invocation writes exactly one JSON document to standard output.
An interactive terminal installer displays human prompts on standard error and writes no JSON result.
Progress, wait heartbeats, warnings, and interactive installer prompts use standard error.
The CLI is a loopback HTTP client and does not implement domain behavior or write runtime state.
The durable await command repeats bounded 25-second polls, retains its acknowledged cursor across runtime restart, and returns only an actionable or terminal result.
Dependency rationale
@tldr/ir supplies the artifact-neutral JSON value types used by the command boundary.
@tldr/server supplies the shared lazy loopback runtime client and lock-file discovery contract.
@tldr/installer supplies the install, status, repair, update, and uninstall operations without linking the installer back to the runtime.
Node's built-in node:util provides argument parsing.
Node's built-in node:crypto provides generated idempotency keys.
Node's built-in node:child_process launches the on-demand runtime only after a runtime command needs it.
No dependency supplies Markdown parsing, browser rendering, SQLite access, or review-domain mutations.
