Skip to content

docs: add the plugin install step to "Use in a repository" - #7

Merged
kalwalt merged 1 commit into
devfrom
docs/plugin-install-step
Oct 10, 2026
Merged

kalwalt merged 1 commit into
devfrom
docs/plugin-install-step

Conversation

@kalwalt

@kalwalt kalwalt commented Oct 10, 2026

Copy link
Copy Markdown
Member

Refs #1. Corrects the README's "Use in a repository" section after checking the enabledPlugins route by hand.

Findings

I checked this in a clone of arjs-plugin-artoolkit, with plugin 0.3.0 from main, no --plugin-dir, and the folder trusted:

  • extraKnownMarketplaces does register the marketplace (claude plugin marketplace list shows arjs-dev-tools).
  • enabledPlugins alone does not load the plugin. /hooks showed no arjs hooks.
  • After claude plugin install arjs@arjs-dev-tools --scope project, /hooks lists the guard and the formatter as arjs@arjs-dev-tools. A git commit on main was blocked by ~/.claude/plugins/cache/arjs-dev-tools/arjs/0.3.0/hooks/guard-protected-branches.mjs.
  • The install rewrites .claude/settings.json: keys sorted, objects expanded.

Changes

  • The snippet is now in the installer's exact form, so installing leaves the committed file unchanged.
  • Adds the contributor steps: trust the folder, run claude plugin install … --scope project, check /hooks.
  • Adds how to update to a newer release (marketplace update + plugin update).
  • The manual-check note now says to ask Claude to run the commit with the Bash tool, because it often refuses a commit on main by itself after reading AGENTS.md, and then the hook is never reached.

This is a docs-only change outside plugins/arjs/, so there is no version bump.

🤖 Generated with Claude Code

Checked in a trusted clone of arjs-plugin-artoolkit: `extraKnownMarketplaces`
registers the marketplace, but `enabledPlugins` alone does not load the
plugin; `claude plugin install arjs@arjs-dev-tools --scope project` does.
The install also rewrites `.claude/settings.json` (keys sorted, objects
expanded), so the snippet is now in that exact form.

Also say how to update to a newer release, and that the manual check must
ask Claude to run the commit, since it often declines on its own.

Refs #1

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kalwalt kalwalt self-assigned this Oct 10, 2026
@kalwalt kalwalt added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 10, 2026
@kalwalt
kalwalt merged commit 3578bda into dev Oct 10, 2026
2 checks passed
@kalwalt
kalwalt deleted the docs/plugin-install-step branch October 10, 2026 14:27
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant