Skip to content

docs(readme): document the plugin update path#6

Merged
dsnger merged 1 commit into
mainfrom
docs/plugin-update-path
Jul 18, 2026
Merged

docs(readme): document the plugin update path#6
dsnger merged 1 commit into
mainfrom
docs/plugin-update-path

Conversation

@dsnger

@dsnger dsnger commented Jul 18, 2026

Copy link
Copy Markdown
Owner

README documented install but not update. A real update attempt failed twice with claude plugin update dev-workflow → "Plugin 'dev-workflow' not found"; the fully qualified dev-workflow@dev-workflow-kit succeeded.

The CLI docs list the bare plugin name as valid for install/uninstall/update alike, so the qualified form is phrased as a workaround, not designed behaviour, and todos.md gets an upstream-report candidate.

Docs-only → Gate B N/A (both staged paths are *.md, neither a prompt path). No ledger row: no fingerprint fits (docs-drift is two artifacts disagreeing; this is a doc that was silent), and the only available "hardening" is the doc addition itself — i.e. the fix, not a rung.

@cursor

cursor Bot commented Jul 18, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@dsnger, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 2 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8c73e33c-7424-4c01-bb07-8a6f7ab9364f

📥 Commits

Reviewing files that changed from the base of the PR and between 793e234 and 10719b1.

📒 Files selected for processing (2)
  • README.md
  • todos.md

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.

@greptile-apps

greptile-apps Bot commented Jul 18, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds documentation for the plugin update path, which was missing from the README's setup section despite the install path already being covered. The documentation also captures a real-world workaround for a CLI bug where the bare plugin name fails on claude plugin update even though the CLI docs list it as valid.

  • README.md: Inserts an update block immediately after the install commands, documenting the two-step flow (marketplace update then plugin update) and calling out the qualified-name workaround with the specific CLI version where the bare-name form fails.
  • todos.md: Adds a ## Next item to track the upstream CLI bug for eventual reporting via /feedback, keeping the workaround rationale in one place.

Confidence Score: 5/5

Docs-only change with no executable code; safe to merge as-is.

Both files are pure Markdown. The README addition accurately describes the two commands needed to update the plugin, correctly labels the qualified-name form as a workaround, and explains the session-reload requirement. The todos.md entry is well-scoped and consistent with the rest of the backlog's format. No code paths, migrations, or config values are touched.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds an update section after the install block documenting the two-step update flow and the known CLI workaround for bare-name resolution failure on CLI 2.1.x
todos.md Adds an upstream-report candidate item to the Next section tracking the bare-name CLI bug for follow-up via /feedback

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants to update dev-workflow-kit] --> B[claude plugin marketplace update dev-workflow-kit]
    B --> C{Try bare-name update}
    C -->|claude plugin update dev-workflow| D["Error: Plugin 'dev-workflow' not found\n(CLI 2.1.x bug)"]
    D --> E[Use qualified form as workaround]
    C -->|Known issue| E
    E --> F[claude plugin update dev-workflow@dev-workflow-kit]
    F --> G[Plugin updated]
    G --> H{Active session?}
    H -->|Yes| I[Restart session or run /reload-plugins]
    H -->|No| J[New session picks up updated version]
    I --> K[Updated version active]
    J --> K
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[User wants to update dev-workflow-kit] --> B[claude plugin marketplace update dev-workflow-kit]
    B --> C{Try bare-name update}
    C -->|claude plugin update dev-workflow| D["Error: Plugin 'dev-workflow' not found\n(CLI 2.1.x bug)"]
    D --> E[Use qualified form as workaround]
    C -->|Known issue| E
    E --> F[claude plugin update dev-workflow@dev-workflow-kit]
    F --> G[Plugin updated]
    G --> H{Active session?}
    H -->|Yes| I[Restart session or run /reload-plugins]
    H -->|No| J[New session picks up updated version]
    I --> K[Updated version active]
    J --> K
Loading

Reviews (1): Last reviewed commit: "docs(readme): document the plugin update..." | Re-trigger Greptile

@dsnger
dsnger merged commit 5acd13e into main Jul 18, 2026
3 checks passed
@dsnger
dsnger deleted the docs/plugin-update-path branch July 18, 2026 21:37
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