Skip to content

docs(readme): expand plugin install, update, enable, and uninstall docs - #24

Merged
robertraf merged 1 commit into
mainfrom
docs/plugin-install-update-instructions
Apr 17, 2026
Merged

docs(readme): expand plugin install, update, enable, and uninstall docs#24
robertraf merged 1 commit into
mainfrom
docs/plugin-install-update-instructions

Conversation

@robertraf

Copy link
Copy Markdown
Owner

Summary

  • Rewrite the Installation section to cover both slash-command and CLI install flows.
  • Document scope selection (user, project, local) and the default.
  • Add an Update section covering claude plugin update <name> -s <scope> and the restart-after-update requirement.
  • Add Enable / Disable guidance — a plugin can be installed but inactive, which is the state a user hits after a fresh install in some scopes.
  • Expand Uninstall to cover the CLI flow, scope flag, marketplace removal, and --keep-data.

Why

Follow-up to #23 (version bump + CI guard). The README only documented the slash-command install path and a one-line uninstall, so users hitting Plugin "sdd" is not installed at scope user or Status: ✘ disabled had no guidance.

Test plan

  • Read the rendered README on GitHub and confirm commands are copy-pasteable.
  • Verify commands against claude plugin --help output (already cross-checked locally).

🤖 Generated with Claude Code

Covers both slash-command and CLI flows, scope selection (user, project,
local), restart-after-update requirement, and the enable/disable step
required when a plugin is installed but inactive.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@robertraf robertraf self-assigned this Apr 17, 2026
@robertraf robertraf added the documentation Improvements or additions to documentation label Apr 17, 2026
@robertraf
robertraf merged commit ef7c59e into main Apr 17, 2026
@robertraf
robertraf deleted the docs/plugin-install-update-instructions branch April 17, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant