Skip to content

docs: Use the npm command in the examples and the help text - #5

Merged
johnxie merged 2 commits into
mainfrom
chore/npm-first-release
Nov 18, 2026
Merged

johnxie merged 2 commits into
mainfrom
chore/npm-first-release

Conversation

@johnxie

@johnxie johnxie commented Nov 18, 2026

Copy link
Copy Markdown
Member

The package goes to npm with this version, so the examples and the help text use npx @taskade/cli.

  • The README examples and the note at the top.
  • The command that plug prints for each client.
  • The two tests that read that text.

How to check: npm test passes, and npx @taskade/cli plug lists the clients after the publish.

Copilot AI lite review requested due to automatic review settings November 18, 2026 23:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified in the CLI command, documentation, and test updates.

No open issues 🎉

What changed in this PR

Updates the CLI documentation, generated command text, and tests to use the published npm package @taskade/cli instead of the GitHub-based invocation.

Changes:

  • Changed the shared command to npx @taskade/cli.
  • Updated README examples and release guidance.
  • Updated client-listing tests to expect the npm command.
File Description
test/​plug.test.mjs Updates client-listing assertions to expect the npm-based command.
src/​clients.mjs Changes the shared CLI invocation used in generated output and help text to npx @taskade/cli.
README.md Replaces GitHub-based command examples and release guidance with npm-based usage.

Review effort: Lite

@johnxie
johnxie merged commit 2b10102 into main Nov 18, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants