Simplifies the CLI README - #129
Conversation
There was a problem hiding this comment.
Pull request overview
This PR significantly reduces the @taskless/cli README to a minimal “what it is / how to run it / where to learn more” document, aligning with the stated goal of removing less-useful detail for now.
Changes:
- Replaces the long-form README (commands, JSON examples, developer/testing notes) with a short description and minimal usage snippet.
- Updates the usage examples to show invoking the package directly via
npx/pnpm dlx. - Adds a single pointer to the Taskless docs site for further documentation.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Pushed Everything factual is verified against source rather than recalled:
Only
|
Builds on the pared-down README with the sections the redesign called for: Install, How to Use via Agents, Taskless Check (CI and constraints), Why Teams Choose Taskless, Docs, a collapsible Other section covering telemetry and its opt-out, and MIT as a footnote. Every command, flag, and env var is taken from source rather than recalled: the install/bin name from packages/cli/package.json, the subcommand list from the built CLI's own --help, the check flags and exit behavior from src/commands/check.ts, the tool detection list from src/install/install.ts, and the telemetry opt-out (TASKLESS_TELEMETRY_DISABLED / DO_NOT_TRACK) from src/telemetry.ts. Fixes #130 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jwc9FFroR3mTZ4hLiSkkX3
The README ships inside the published tarball — npm includes it regardless of `files` — so the rewrite reaches users and earns a release note. Patch level: the repo is pre-1.0 and no behavior changed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jwc9FFroR3mTZ4hLiSkkX3
3537304 to
3301517
Compare
The CLI README had a bunch of information that was not useful. This pares it down to the bare minimum for simplicity. Will receive updates with additional info