Skip to content

docs: simplify npm installer examples - #46

Merged
777genius merged 1 commit into
mainfrom
docs/unversioned-agentplugins-examples
Aug 9, 2026
Merged

docs: simplify npm installer examples#46
777genius merged 1 commit into
mainfrom
docs/unversioned-agentplugins-examples

Conversation

@777genius

@777genius 777genius commented Aug 9, 2026

Copy link
Copy Markdown
Owner

Keep CLI examples copy-ready and versionless:

npx universal-agent-plugins add context7

This updates both the repository README and the npm package README, including lifecycle, local package, GitHub source, and state migration examples.

A repository contract test now rejects npx universal-agent-plugins@<version> in either public README while keeping release records versioned where reproducibility requires it.

Targeted repository tests pass.

Summary by CodeRabbit

  • Documentation

    • Updated command examples to use the unversioned universal-agent-plugins package name.
    • Removed explicit package version references from installation, lifecycle, source installation, and migration examples.
  • Tests

    • Added validation to ensure README examples consistently use unversioned commands.

@777genius
777genius merged commit 153989a into main Aug 9, 2026
12 of 13 checks passed
@777genius
777genius deleted the docs/unversioned-agentplugins-examples branch August 9, 2026 10:57
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e5023942-de8e-4d89-b4e5-c79162fca980

📥 Commits

Reviewing files that changed from the base of the PR and between 80fe57a and c23aa9f.

📒 Files selected for processing (3)
  • README.md
  • npm/agentplugins/README.md
  • repotests/agentplugins_release_contract_test.go

📝 Walkthrough

Walkthrough

The README files now use unversioned universal-agent-plugins commands. A repository contract test verifies both README files contain the unversioned form and reject version-qualified examples.

Changes

Agent plugin command documentation

Layer / File(s) Summary
Update README command examples
README.md, npm/agentplugins/README.md
Installation, lifecycle, source installation, migration, dry-run, and target-specific examples no longer pin version 0.1.4.
Enforce unversioned command contract
repotests/agentplugins_release_contract_test.go
A repository test requires unversioned npx universal-agent-plugins add context7 examples and rejects version-qualified commands.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Poem

A rabbit hops through docs so neat,
Unpinned commands make the change complete.
Tests watch each example’s form,
Versioned commands face the storm.
“Hop, hop!” says Bun, “the contract is warm!”

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/unversioned-agentplugins-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant