conventional-git 1.1.0__tar.gz → 1.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.claude-plugin/plugin.json +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.github/workflows/ci.yml +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.github/workflows/publish.yml +3 -3
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.github/workflows/python.yml +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.pre-commit-config.yaml +1 -1
- conventional_git-1.3.0/AGENTS.md +105 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/CONTRIBUTING.md +4 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/Makefile +12 -4
- {conventional_git-1.1.0 → conventional_git-1.3.0}/PKG-INFO +14 -6
- {conventional_git-1.1.0 → conventional_git-1.3.0}/README.md +12 -4
- {conventional_git-1.1.0 → conventional_git-1.3.0}/dictionary.txt +1 -1
- conventional_git-1.3.0/docs/agents/agent-skills-format.md +69 -0
- conventional_git-1.3.0/docs/agents/claude-code-install-scopes.md +51 -0
- conventional_git-1.3.0/docs/agents/claude-code-marketplace-install.md +68 -0
- conventional_git-1.3.0/docs/agents/claude-code-plugin-updates.md +72 -0
- conventional_git-1.3.0/docs/agents/claude-code-shell-install.md +59 -0
- conventional_git-1.3.0/docs/agents/claude-code-skill-invocation.md +53 -0
- conventional_git-1.3.0/docs/agents/index.md +50 -0
- conventional_git-1.3.0/docs/agents/install-channels.md +66 -0
- conventional_git-1.3.0/docs/agents/npx-skills-install.md +66 -0
- conventional_git-1.3.0/docs/agents/npx-skills-manage.md +59 -0
- conventional_git-1.3.0/docs/agents/opencode-mcp-config.md +84 -0
- conventional_git-1.3.0/docs/agents/opencode-mcp-server.md +69 -0
- conventional_git-1.3.0/docs/agents/opencode-skill-discovery.md +51 -0
- conventional_git-1.3.0/docs/agents/opencode-skill-permissions.md +49 -0
- conventional_git-1.3.0/docs/agents/plugin-identity.md +72 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/optional-extras.md +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/three-layers.md +1 -1
- conventional_git-1.3.0/docs/conventions/claude-md-check.md +21 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/conventions/commits-check.md +16 -6
- conventional_git-1.3.0/docs/conventions/help-check.md +22 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/conventions/index.md +4 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/pre-commit-framework.md +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/pre-commit-local-hooks.md +2 -2
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/index.md +5 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/log.md +47 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/index.md +3 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/plugin-bundled-server.md +5 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/toolchain/index.md +2 -0
- conventional_git-1.3.0/docs/toolchain/sh-uid-unused.md +23 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/mk/python.mk +14 -7
- {conventional_git-1.1.0 → conventional_git-1.3.0}/package.json +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/pnpm-lock.yaml +120 -120
- {conventional_git-1.1.0 → conventional_git-1.3.0}/pyproject.toml +5 -23
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/app.py +2 -2
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/auth.py +2 -2
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/capabilities.py +3 -3
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/check.py +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/create.py +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/hook.py +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/mcp.py +1 -1
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/mcp/server.py +3 -3
- conventional_git-1.3.0/tests/test_sh_uid_unused.py +39 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/uv.lock +66 -103
- conventional_git-1.1.0/AGENTS.md +0 -80
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.claude-plugin/marketplace.json +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.editorconfig +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.github/dependabot.yml +2 -2
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.gitignore +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.markdownlint-cli2.jsonc +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.markdownlint.yaml +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.mcp.json +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/.pre-commit-hooks.yaml +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/LICENSE +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/checkmake.ini +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/cspell.config.yaml +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/validation-vs-generation.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/violation-contract.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/architecture/vocabulary-as-data.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/conventions/commits-and-branches.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/attribution-trailers.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/branch-name-gap.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/ci-recipe.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/commitizen-adapter.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/git-hooks.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/hook-install-path.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/house-rules.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/enforcement/skill-vocabulary-copies.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/behavior-vs-cli.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/extra-path.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/install.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/recommended-config.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/when-to-use.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/gitlint/wiring.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/describe-convention.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/self-correction-loop.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/server-install.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/suggest-commit-message.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/mcp/validate-tools.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/python/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/python/interpreter-source.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/python/pyproject-defaults.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/release/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/release/pypi-trusted-publishing.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/apply-does-not-commit.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/data-egress.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/index.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/keyring-scope.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/llm-extra-install.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/provider-fallback.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/suggestions/providers-and-credentials.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/toolchain/extras-self-reference.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/toolchain/layering-rule.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/docs/toolchain/rejected-install-backends.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/mise.toml +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/mk/.gitkeep +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/mk/conventional-git.mk +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/pnpm-workspace.yaml +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/skills/conventional-branch/SKILL.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/skills/conventional-branch/references/branch-types.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/skills/conventional-commit/SKILL.md +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/skills/conventional-commit/references/commit-types.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/adapters/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/adapters/commitizen_config.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/adapters/gitlint_rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/branch/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/branch/grammar.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/branch/rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/branch/vocabulary.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/cli/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/commit/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/commit/compose.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/commit/grammar.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/commit/rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/commit/vocabulary.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/config.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/csv_columns.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/branch-exempt-prefixes.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/branch-trunks.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/branch-types.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/commit-attribution.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/data/commit-types.csv +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/credentials.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/diff.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/heuristic.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/protocol.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/generation/typesafe.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/helpers.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/mcp/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/py.typed +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/src/conventional_git/violations.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/__init__.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_branch_rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_branch_vocabulary.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_cli_auth.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_cli_capabilities.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_cli_hook.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_cli_smoke.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_commit_compose.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_commit_rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_commit_vocabulary.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_config.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_credentials.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_diff.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_generation_suggest.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_gitlint_rules.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_helpers.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_heuristic.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_mcp_server.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_plugin_version.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_skill_vocabularies.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_typesafe_client_factory.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_typesafe_provider.py +0 -0
- {conventional_git-1.1.0 → conventional_git-1.3.0}/tests/test_violation_code_coverage.py +0 -0
|
@@ -7,10 +7,10 @@ jobs:
|
|
|
7
7
|
build:
|
|
8
8
|
runs-on: ubuntu-latest
|
|
9
9
|
steps:
|
|
10
|
-
- uses: actions/checkout@
|
|
10
|
+
- uses: actions/checkout@v7
|
|
11
11
|
- uses: jdx/mise-action@v4
|
|
12
12
|
- run: make build
|
|
13
|
-
- uses: actions/upload-artifact@
|
|
13
|
+
- uses: actions/upload-artifact@v7
|
|
14
14
|
with:
|
|
15
15
|
name: dist
|
|
16
16
|
path: dist/
|
|
@@ -21,7 +21,7 @@ jobs:
|
|
|
21
21
|
permissions:
|
|
22
22
|
id-token: write
|
|
23
23
|
steps:
|
|
24
|
-
- uses: actions/download-artifact@
|
|
24
|
+
- uses: actions/download-artifact@v8
|
|
25
25
|
with:
|
|
26
26
|
name: dist
|
|
27
27
|
path: dist/
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
|
|
4
|
+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
|
|
5
|
+
interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
|
6
|
+
|
|
7
|
+
## Agent instructions
|
|
8
|
+
|
|
9
|
+
- `AGENTS.md` is the only agent instructions file; put project rules here. The
|
|
10
|
+
repository MUST NOT contain a `CLAUDE.md` or any other tool-specific copy,
|
|
11
|
+
because a second copy drifts from this one; `make claude-md-check` fails on
|
|
12
|
+
one.
|
|
13
|
+
|
|
14
|
+
## Command surface
|
|
15
|
+
|
|
16
|
+
- Run the `Makefile` targets (`make check`, `make fix`, `make test`, ...)
|
|
17
|
+
instead of the underlying tools, so the agent and CI use the same options.
|
|
18
|
+
`make help` lists them.
|
|
19
|
+
- Give every new target a `##` help line; `make help` prints it and
|
|
20
|
+
`make help-check` fails on a target without one.
|
|
21
|
+
|
|
22
|
+
## Gate
|
|
23
|
+
|
|
24
|
+
- `make check` and `make test` MUST pass before any commit.
|
|
25
|
+
- Run `make fix` first for findings it can repair, then edit by hand.
|
|
26
|
+
|
|
27
|
+
## Commits and branches
|
|
28
|
+
|
|
29
|
+
- Write commit messages as
|
|
30
|
+
[Conventional Commits](https://www.conventionalcommits.org/) and branch
|
|
31
|
+
names as [Conventional Branch](https://conventionalbranch.org/)
|
|
32
|
+
(`<type>/<description>`, e.g. `feat/add-enforcement`,
|
|
33
|
+
`fix/normalize-description-grammar`). A pre-commit hook and
|
|
34
|
+
`make commits-check` enforce both; see
|
|
35
|
+
[`docs/conventions/commits-check.md`](docs/conventions/commits-check.md).
|
|
36
|
+
- Name a documentation or dependency branch `chore/...`: a branch type is not
|
|
37
|
+
a commit type, and `docs/` is not one.
|
|
38
|
+
|
|
39
|
+
## Pull requests
|
|
40
|
+
|
|
41
|
+
Once a pull request is open, the agent MUST:
|
|
42
|
+
|
|
43
|
+
1. Wait for CI; while it fails, fix the cause, push to the same branch and
|
|
44
|
+
wait again until it passes.
|
|
45
|
+
2. Squash-merge a pull request with exactly one commit and use a regular merge
|
|
46
|
+
commit otherwise (`gh pr view --json commits` gives the count).
|
|
47
|
+
3. Delete the branch on the remote and locally.
|
|
48
|
+
4. Switch back to the base branch, pull it and run `git fetch --prune`.
|
|
49
|
+
|
|
50
|
+
## Documentation
|
|
51
|
+
|
|
52
|
+
- Follow the organization's shared documentation-writing guide, kept in one
|
|
53
|
+
place rather than copied into this repository so it cannot drift from other
|
|
54
|
+
projects that follow the same guide.
|
|
55
|
+
- Add a new `docs/` note to its directory's `index.md` and, by file name, to
|
|
56
|
+
[`docs/log.md`](docs/log.md).
|
|
57
|
+
- Cover exactly one concept per note.
|
|
58
|
+
- Write a note only when it explains something a reader cannot already get
|
|
59
|
+
from `make help`, a linter's own message, or the configuration it comes
|
|
60
|
+
from.
|
|
61
|
+
|
|
62
|
+
## Dependencies
|
|
63
|
+
|
|
64
|
+
- Add a new tool to the ecosystem manager that owns it (`package.json` for
|
|
65
|
+
Node, `pyproject.toml` `[dependency-groups].dev` for Python); use
|
|
66
|
+
`mise.toml` only for a tool that bootstraps an ecosystem or has no manager
|
|
67
|
+
in this repository.
|
|
68
|
+
- Declare a tool in one layer only: two pins can drift and the gate would no
|
|
69
|
+
longer cover both. See
|
|
70
|
+
[`docs/toolchain/layering-rule.md`](docs/toolchain/layering-rule.md).
|
|
71
|
+
|
|
72
|
+
## Layering
|
|
73
|
+
|
|
74
|
+
The codebase is intentionally three layers; the agent MUST NOT cross the
|
|
75
|
+
boundaries below.
|
|
76
|
+
|
|
77
|
+
1. **Spec core** — `conventional_git.commit.*` and `conventional_git.branch.*`.
|
|
78
|
+
Pure functions, no git calls, no `SystemExit`, no I/O. Validation returns
|
|
79
|
+
a `Report` of `Violation`s. This is the only layer that holds rules.
|
|
80
|
+
2. **Adapters** — `conventional_git.adapters.*` (gitlint rules, commitizen
|
|
81
|
+
schema emitter). Translate `Violation` into the consumer tool's error
|
|
82
|
+
type. The adapter is the only place that imports the consumer SDK.
|
|
83
|
+
3. **Front-ends** — `conventional_git.cli.*` and `conventional_git.mcp.*`.
|
|
84
|
+
Map user input into core calls and core output into user output. These
|
|
85
|
+
are the only layers that may call `SystemExit`.
|
|
86
|
+
|
|
87
|
+
A new rule MUST land in the core; an adapter that hardcodes the rule
|
|
88
|
+
duplicates it. A new vocabulary entry MUST land in
|
|
89
|
+
`data/{commit,branch}-types.csv`; a regex inside the core is a bug, not a
|
|
90
|
+
feature.
|
|
91
|
+
|
|
92
|
+
## Python
|
|
93
|
+
|
|
94
|
+
- Write no docstrings on functions, methods or classes; add a comment only
|
|
95
|
+
where the *why* is not obvious from the code. `pylint-gajaguar`'s
|
|
96
|
+
`gajaguar-no-docstrings` fails `make check` on any docstring.
|
|
97
|
+
- Enable the plugin with `enable = ["gajaguar"]` in `pyproject.toml`'s
|
|
98
|
+
`[tool.pylint."messages control"]`, not with a list of rules, so a rule
|
|
99
|
+
added by a `pylint-gajaguar` upgrade runs without a config change.
|
|
100
|
+
- Keep `pyproject.toml` to settings that differ from the tool's default, and
|
|
101
|
+
keep a `lint.per-file-ignores` entry only while it matches a current
|
|
102
|
+
violation; see
|
|
103
|
+
[`docs/python/pyproject-defaults.md`](docs/python/pyproject-defaults.md).
|
|
104
|
+
- Keep the spec core free of `git` imports and `SystemExit`. Returning a
|
|
105
|
+
`Report` is the contract; only front-ends turn violations into exit codes.
|
|
@@ -33,7 +33,10 @@ This repository dogfoods its own rules:
|
|
|
33
33
|
[Conventional Commits](https://www.conventionalcommits.org/).
|
|
34
34
|
- Branch names MUST follow
|
|
35
35
|
[Conventional Branch](https://conventionalbranch.org/)
|
|
36
|
-
(`<type>/<description>`, e.g. `fix/normalize-branch-name`).
|
|
36
|
+
(`<type>/<description>`, e.g. `fix/normalize-branch-name`). The branch
|
|
37
|
+
type is one of `feat` (or `feature`), `fix` (or `bugfix`), `hotfix`,
|
|
38
|
+
`release`, or `chore`; documentation and dependency work uses `chore/`,
|
|
39
|
+
because `docs/` is not a branch type.
|
|
37
40
|
- Commit messages MUST NOT carry an attribution trailer (`Co-Authored-By:`,
|
|
38
41
|
"Generated with …", a 🤖 marker); the project's own commit-msg hook
|
|
39
42
|
rejects them — see
|
|
@@ -67,15 +67,23 @@ spell: ## Spell-check files with cspell — accepts FILES="..."
|
|
|
67
67
|
fi
|
|
68
68
|
|
|
69
69
|
commits-check: ## Validate the commit range and branch name against Conventional Commits/Branch — see docs/conventions/commits-check.md
|
|
70
|
-
@git log --format='%B%x00' $(BASE)..HEAD | while IFS= read -r -d '' message; do \
|
|
70
|
+
@git log --no-merges --format='%B%x00' $(BASE)..HEAD | while IFS= read -r -d '' message; do \
|
|
71
71
|
message="$${message#$$'\n'}"; [ -z "$$message" ] && continue; \
|
|
72
72
|
echo "$$message" | $(CONVENTIONAL_GIT) check commit || exit 1; \
|
|
73
73
|
done
|
|
74
|
-
@$(
|
|
74
|
+
@$(CONVENTIONAL_GIT) check branch --name "$(BRANCH)"
|
|
75
75
|
|
|
76
|
-
check:
|
|
76
|
+
help-check: ## Fail if a Makefile target lacks its ## help line — see docs/conventions/help-check.md
|
|
77
|
+
@missing=$$(grep -HnE '^[a-zA-Z][a-zA-Z0-9_-]*[[:space:]]*:([^=]|$$)' Makefile mk/*.mk 2>/dev/null | grep -v '##' || true); \
|
|
78
|
+
test -z "$$missing" || { echo "target without a ## help line:" >&2; echo "$$missing" >&2; exit 1; }
|
|
77
79
|
|
|
78
|
-
|
|
80
|
+
claude-md-check: ## Fail if a CLAUDE.md exists, since AGENTS.md is the only agent file — see docs/conventions/claude-md-check.md
|
|
81
|
+
@found=$$(git ls-files --cached --others --exclude-standard | grep -E '(^|/)CLAUDE\.md$$' || true); \
|
|
82
|
+
test -z "$$found" || { echo "CLAUDE.md found; fold it into AGENTS.md and delete it:" >&2; echo "$$found" >&2; exit 1; }
|
|
83
|
+
|
|
84
|
+
check: makefile-lint md-lint spell commits-check help-check claude-md-check $(LANG_CHECK_TARGETS) ## Run the full read-only validation gate
|
|
85
|
+
|
|
86
|
+
.PHONY: makefile-lint md-lint spell commits-check help-check claude-md-check check
|
|
79
87
|
|
|
80
88
|
##@ Writable fixes (mutate files in place)
|
|
81
89
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: conventional-git
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.3.0
|
|
4
4
|
Summary: Conventional Commits and Conventional Branch enforcement, validation, and generation
|
|
5
5
|
Project-URL: Repository, https://github.com/gajaguar/conventional-git
|
|
6
6
|
Project-URL: Issues, https://github.com/gajaguar/conventional-git/issues
|
|
@@ -16,7 +16,7 @@ Provides-Extra: llm
|
|
|
16
16
|
Requires-Dist: keyring>=25.7; extra == 'llm'
|
|
17
17
|
Requires-Dist: typesafe-sdk>=0.7; extra == 'llm'
|
|
18
18
|
Provides-Extra: mcp
|
|
19
|
-
Requires-Dist: mcp<2
|
|
19
|
+
Requires-Dist: mcp<3,>=2.2; extra == 'mcp'
|
|
20
20
|
Description-Content-Type: text/markdown
|
|
21
21
|
|
|
22
22
|
# conventional-git
|
|
@@ -225,26 +225,34 @@ The server exposes `validate_commit_message`, `validate_branch_name`,
|
|
|
225
225
|
|
|
226
226
|
The repository is both a Claude Code plugin and an
|
|
227
227
|
[Agent Skills](https://agentskills.io/specification)-compliant `skills/`
|
|
228
|
-
directory.
|
|
228
|
+
directory. See [`docs/agents/index.md`](docs/agents/index.md) for the full
|
|
229
|
+
install guide; one command per channel.
|
|
229
230
|
|
|
230
|
-
**Claude Code
|
|
231
|
-
`conventional-commit`, `conventional-branch`, and the MCP server
|
|
231
|
+
**Claude Code**: add the marketplace, then install the plugin. It bundles
|
|
232
|
+
`conventional-commit`, `conventional-branch`, and the MCP server:
|
|
232
233
|
|
|
233
234
|
```text
|
|
234
235
|
/plugin marketplace add gajaguar/conventional-git
|
|
235
236
|
/plugin install conventional-git@conventional-git-skills
|
|
237
|
+
/reload-plugins
|
|
236
238
|
```
|
|
237
239
|
|
|
238
240
|
See [`docs/mcp/plugin-bundled-server.md`](docs/mcp/plugin-bundled-server.md)
|
|
239
241
|
for how the bundled `.mcp.json` launches the server.
|
|
240
242
|
|
|
241
243
|
**Any other agent that supports Agent Skills** (Codex, Cursor, Gemini CLI,
|
|
242
|
-
Copilot,
|
|
244
|
+
Copilot, and others):
|
|
243
245
|
|
|
244
246
|
```bash
|
|
245
247
|
npx skills add gajaguar/conventional-git
|
|
246
248
|
```
|
|
247
249
|
|
|
250
|
+
**opencode**:
|
|
251
|
+
|
|
252
|
+
```bash
|
|
253
|
+
npx skills add gajaguar/conventional-git -a opencode -y
|
|
254
|
+
```
|
|
255
|
+
|
|
248
256
|
Skills call `conventional-git capabilities --json` before drafting, so they
|
|
249
257
|
only offer `create suggest` (see [Suggest](#suggest)) when the `llm` extra
|
|
250
258
|
and a credential are both present, and never send a diff to a third party
|
|
@@ -204,26 +204,34 @@ The server exposes `validate_commit_message`, `validate_branch_name`,
|
|
|
204
204
|
|
|
205
205
|
The repository is both a Claude Code plugin and an
|
|
206
206
|
[Agent Skills](https://agentskills.io/specification)-compliant `skills/`
|
|
207
|
-
directory.
|
|
207
|
+
directory. See [`docs/agents/index.md`](docs/agents/index.md) for the full
|
|
208
|
+
install guide; one command per channel.
|
|
208
209
|
|
|
209
|
-
**Claude Code
|
|
210
|
-
`conventional-commit`, `conventional-branch`, and the MCP server
|
|
210
|
+
**Claude Code**: add the marketplace, then install the plugin. It bundles
|
|
211
|
+
`conventional-commit`, `conventional-branch`, and the MCP server:
|
|
211
212
|
|
|
212
213
|
```text
|
|
213
214
|
/plugin marketplace add gajaguar/conventional-git
|
|
214
215
|
/plugin install conventional-git@conventional-git-skills
|
|
216
|
+
/reload-plugins
|
|
215
217
|
```
|
|
216
218
|
|
|
217
219
|
See [`docs/mcp/plugin-bundled-server.md`](docs/mcp/plugin-bundled-server.md)
|
|
218
220
|
for how the bundled `.mcp.json` launches the server.
|
|
219
221
|
|
|
220
222
|
**Any other agent that supports Agent Skills** (Codex, Cursor, Gemini CLI,
|
|
221
|
-
Copilot,
|
|
223
|
+
Copilot, and others):
|
|
222
224
|
|
|
223
225
|
```bash
|
|
224
226
|
npx skills add gajaguar/conventional-git
|
|
225
227
|
```
|
|
226
228
|
|
|
229
|
+
**opencode**:
|
|
230
|
+
|
|
231
|
+
```bash
|
|
232
|
+
npx skills add gajaguar/conventional-git -a opencode -y
|
|
233
|
+
```
|
|
234
|
+
|
|
227
235
|
Skills call `conventional-git capabilities --json` before drafting, so they
|
|
228
236
|
only offer `create suggest` (see [Suggest](#suggest)) when the `llm` extra
|
|
229
237
|
and a credential are both present, and never send a diff to a third party
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: reference
|
|
3
|
+
title: Agent Skills format
|
|
4
|
+
description: SKILL.md frontmatter fields and their constraints, progressive disclosure, and the optional references/ subdirectory.
|
|
5
|
+
tags: [agents, skills]
|
|
6
|
+
status: stable
|
|
7
|
+
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
|
+
stale_after: 2027-03-29T00:00:00Z
|
|
9
|
+
sources:
|
|
10
|
+
- id: agentskills-spec
|
|
11
|
+
resource: https://agentskills.io/specification
|
|
12
|
+
title: Agent Skills specification
|
|
13
|
+
author: team:agentskills
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Agent Skills format
|
|
17
|
+
|
|
18
|
+
An Agent Skill is a directory that contains a `SKILL.md` file: YAML
|
|
19
|
+
frontmatter followed by Markdown instructions. Agents load the `name`
|
|
20
|
+
and `description` at startup to decide when a skill applies.[^agentskills-spec]
|
|
21
|
+
|
|
22
|
+
| Field | Required | Purpose |
|
|
23
|
+
| :-------------- | :------- | :------------------------------------------ |
|
|
24
|
+
| `name` | Yes | Skill identifier |
|
|
25
|
+
| `description` | Yes | What the skill does and when to use it |
|
|
26
|
+
| `license` | No | License name or bundled license file |
|
|
27
|
+
| `compatibility` | No | Environment requirements |
|
|
28
|
+
| `metadata` | No | String-to-string map of extra properties |
|
|
29
|
+
| `allowed-tools` | No | Pre-approved tools (experimental) |
|
|
30
|
+
|
|
31
|
+
Constraints from the specification:[^agentskills-spec]
|
|
32
|
+
|
|
33
|
+
* `name`: 1-64 characters; lowercase letters, digits, and hyphens only;
|
|
34
|
+
no leading, trailing, or consecutive hyphens; must match the parent
|
|
35
|
+
directory name.
|
|
36
|
+
* `description`: 1-1024 characters; say what the skill does and when to
|
|
37
|
+
use it.
|
|
38
|
+
* `license`: a license name or a reference to a bundled license file;
|
|
39
|
+
keep it short.
|
|
40
|
+
* `compatibility`: 1-500 characters; for example the intended product,
|
|
41
|
+
system packages, or network access.
|
|
42
|
+
* `metadata`: a map from string keys to string values; use reasonably
|
|
43
|
+
unique key names.
|
|
44
|
+
* `allowed-tools`: a space-separated string of pre-approved tools.
|
|
45
|
+
Experimental, so support varies between agents.
|
|
46
|
+
|
|
47
|
+
## Progressive disclosure
|
|
48
|
+
|
|
49
|
+
Agents load a skill in three steps:[^agentskills-spec]
|
|
50
|
+
|
|
51
|
+
1. **Metadata** (about 100 tokens): `name` and `description`, loaded
|
|
52
|
+
at startup for every skill.
|
|
53
|
+
2. **Instructions** (under 5000 tokens recommended): the full
|
|
54
|
+
`SKILL.md` body, loaded when the skill activates.
|
|
55
|
+
3. **Resources**: files under `scripts/`, `references/`, or `assets/`,
|
|
56
|
+
loaded only when needed.
|
|
57
|
+
|
|
58
|
+
Keep `SKILL.md` under 500 lines and move detailed material into
|
|
59
|
+
separate files.
|
|
60
|
+
|
|
61
|
+
## `references/` subdirectory
|
|
62
|
+
|
|
63
|
+
A skill may put additional documentation under `references/` (for
|
|
64
|
+
example `REFERENCE.md` or a domain-specific file) and link to it with a
|
|
65
|
+
relative path from the skill root. Agents read these files on demand, so
|
|
66
|
+
keep each one focused. Keep references one level deep from
|
|
67
|
+
`SKILL.md`.[^agentskills-spec]
|
|
68
|
+
|
|
69
|
+
[^agentskills-spec]: Agent Skills specification
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: reference
|
|
3
|
+
title: Claude Code install scopes
|
|
4
|
+
description: user, project, and local scopes — which settings file each writes to, the precedence order, and when each is the right choice.
|
|
5
|
+
tags: [agents, claude-code]
|
|
6
|
+
status: stable
|
|
7
|
+
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
|
+
stale_after: 2027-03-29T00:00:00Z
|
|
9
|
+
sources:
|
|
10
|
+
- id: claude-discover-plugins
|
|
11
|
+
resource: https://code.claude.com/docs/en/discover-plugins
|
|
12
|
+
title: Discover and install Claude Code plugins
|
|
13
|
+
author: team:anthropic
|
|
14
|
+
- id: claude-loading
|
|
15
|
+
resource: https://code.claude.com/docs/en/plugins/loading
|
|
16
|
+
title: How Claude Code loads plugins
|
|
17
|
+
author: team:anthropic
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Claude Code install scopes
|
|
21
|
+
|
|
22
|
+
Every install, by `/plugin install` or `claude plugin install`, is
|
|
23
|
+
recorded in a settings file under one of three scopes.[^claude-discover-plugins]
|
|
24
|
+
|
|
25
|
+
| Scope | Settings file | Reaches |
|
|
26
|
+
| :-------- | :----------------------------------- | :-------------------------------------- |
|
|
27
|
+
| `user` | `~/.claude/settings.json` | You, in every project on this machine |
|
|
28
|
+
| `project` | `.claude/settings.json` (committed) | Everyone who works in the repository |
|
|
29
|
+
| `local` | `.claude/settings.local.json` | You, in this repository only |
|
|
30
|
+
|
|
31
|
+
The entry is written under `enabledPlugins` in that file.
|
|
32
|
+
|
|
33
|
+
## Which scope to pick
|
|
34
|
+
|
|
35
|
+
* **`user`**: the default for `claude plugin install`. Use it for
|
|
36
|
+
plugins you want in every project.
|
|
37
|
+
* **`project`**: the entry lives in the committed `.claude/settings.json`.
|
|
38
|
+
Use it when the repository itself depends on the plugin. Committing the
|
|
39
|
+
entry enables the plugin for collaborators but does not download it, so
|
|
40
|
+
each collaborator runs
|
|
41
|
+
`claude plugin install <plugin>@<marketplace> --scope project` once.[^claude-loading]
|
|
42
|
+
* **`local`**: the entry lives in `.claude/settings.local.json`. Use it
|
|
43
|
+
for a personal setup in one repository.
|
|
44
|
+
|
|
45
|
+
## Precedence
|
|
46
|
+
|
|
47
|
+
When the same plugin is set at several scopes, `local` overrides
|
|
48
|
+
`project`, and `project` overrides `user`.[^claude-loading]
|
|
49
|
+
|
|
50
|
+
[^claude-discover-plugins]: Discover and install Claude Code plugins
|
|
51
|
+
[^claude-loading]: How Claude Code loads plugins
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: playbook
|
|
3
|
+
title: Installing through the Claude Code marketplace
|
|
4
|
+
description: Add a marketplace and install a plugin from it inside a Claude Code session, including the one-step form and the reload.
|
|
5
|
+
tags: [agents, claude-code]
|
|
6
|
+
status: stable
|
|
7
|
+
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
|
+
stale_after: 2027-03-29T00:00:00Z
|
|
9
|
+
sources:
|
|
10
|
+
- id: claude-discover-plugins
|
|
11
|
+
resource: https://code.claude.com/docs/en/discover-plugins
|
|
12
|
+
title: Discover and install Claude Code plugins
|
|
13
|
+
author: team:anthropic
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Installing through the Claude Code marketplace
|
|
17
|
+
|
|
18
|
+
Use the `/plugin` slash commands inside a Claude Code session to add a
|
|
19
|
+
marketplace and install a plugin from it.[^claude-discover-plugins]
|
|
20
|
+
|
|
21
|
+
## Two commands
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
/plugin marketplace add <owner>/<repo>[#ref]
|
|
25
|
+
/plugin install <plugin>@<marketplace>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Add `#ref` to pin a branch or tag. `<marketplace>` is the name the
|
|
29
|
+
marketplace registered under, and `<plugin>` is the plugin's name. Both
|
|
30
|
+
names are listed in [`plugin-identity.md`](plugin-identity.md).
|
|
31
|
+
|
|
32
|
+
In a session, `/plugin install` does not install right away. It opens
|
|
33
|
+
the `/plugin` panel on the plugin's details so you can review it and
|
|
34
|
+
pick a scope: user, project (all collaborators on the repository), or
|
|
35
|
+
local (you, this repository only).
|
|
36
|
+
|
|
37
|
+
## One-step form
|
|
38
|
+
|
|
39
|
+
To add a marketplace and install from it in one command, pass
|
|
40
|
+
`--marketplace` with the marketplace source. This form requires Claude
|
|
41
|
+
Code v2.1.275 or later.
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
/plugin install <plugin> --marketplace <owner>/<repo>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Give the plugin name by itself, without an `@<marketplace>` suffix. If
|
|
48
|
+
the marketplace is not added yet, Claude Code shows the source it
|
|
49
|
+
resolved and asks you to confirm before adding it.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
You choose the scope in the panel, not with a flag. The `--scope` flag
|
|
54
|
+
belongs to the shell command; see
|
|
55
|
+
[`claude-code-shell-install.md`](claude-code-shell-install.md). For what
|
|
56
|
+
each scope writes, see
|
|
57
|
+
[`claude-code-install-scopes.md`](claude-code-install-scopes.md).
|
|
58
|
+
|
|
59
|
+
## Reload
|
|
60
|
+
|
|
61
|
+
The install summary ends with one of two outcomes: `Plugin is now
|
|
62
|
+
active.`, or `Run /reload-plugins to activate.` In the second case, the
|
|
63
|
+
panel closes and Claude Code runs the reload for you. If the reload
|
|
64
|
+
would invalidate the prompt cache, Claude Code warns and leaves the
|
|
65
|
+
plugin pending; run `/reload-plugins --force` to activate it
|
|
66
|
+
anyway.[^claude-discover-plugins]
|
|
67
|
+
|
|
68
|
+
[^claude-discover-plugins]: Discover and install Claude Code plugins
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: playbook
|
|
3
|
+
title: Updating and uninstalling Claude Code plugins
|
|
4
|
+
description: Auto-update is off by default for third-party marketplaces, so update by hand and reload; uninstall the plugin and remove the marketplace when you are done.
|
|
5
|
+
tags: [agents, claude-code]
|
|
6
|
+
status: stable
|
|
7
|
+
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
|
+
stale_after: 2027-03-29T00:00:00Z
|
|
9
|
+
sources:
|
|
10
|
+
- id: claude-discover-plugins
|
|
11
|
+
resource: https://code.claude.com/docs/en/discover-plugins
|
|
12
|
+
title: Discover and install Claude Code plugins
|
|
13
|
+
author: team:anthropic
|
|
14
|
+
- id: claude-loading
|
|
15
|
+
resource: https://code.claude.com/docs/en/plugins/loading
|
|
16
|
+
title: How Claude Code loads plugins
|
|
17
|
+
author: team:anthropic
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Updating and uninstalling Claude Code plugins
|
|
21
|
+
|
|
22
|
+
Auto-update is off by default for third-party marketplaces, so update
|
|
23
|
+
those plugins by hand. It is on by default for the official Anthropic
|
|
24
|
+
marketplaces and for marketplaces added from claude.ai.[^claude-discover-plugins]
|
|
25
|
+
|
|
26
|
+
## Update by hand
|
|
27
|
+
|
|
28
|
+
In a Claude Code session, refresh the marketplace, then update the
|
|
29
|
+
plugin from the `/plugin` panel:
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
/plugin marketplace update <marketplace>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Open the plugin on the **Installed** tab in `/plugin` and select
|
|
36
|
+
**Update now**.
|
|
37
|
+
|
|
38
|
+
From your shell:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
claude plugin marketplace update <marketplace>
|
|
42
|
+
claude plugin update <plugin>@<marketplace>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The running session keeps the versions it already loaded. Run
|
|
46
|
+
`/reload-plugins` to apply an update in that session, or start a new
|
|
47
|
+
session.[^claude-loading]
|
|
48
|
+
|
|
49
|
+
## Turn auto-update on for a marketplace
|
|
50
|
+
|
|
51
|
+
Run `/plugin`, open the **Marketplaces** tab, select the marketplace,
|
|
52
|
+
and choose **Enable auto-update**.[^claude-discover-plugins]
|
|
53
|
+
|
|
54
|
+
## Disable without uninstalling
|
|
55
|
+
|
|
56
|
+
Use `/plugin disable <plugin>` in a session, or `claude plugin disable
|
|
57
|
+
<plugin>@<marketplace>` in your shell, to keep the plugin installed but
|
|
58
|
+
stop loading it.
|
|
59
|
+
|
|
60
|
+
## Uninstall
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
/plugin uninstall <plugin>@<marketplace>
|
|
64
|
+
/plugin marketplace remove <marketplace>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Uninstalling a plugin leaves the marketplace registered. Removing a
|
|
68
|
+
marketplace uninstalls every plugin you installed from it and removes
|
|
69
|
+
their `enabledPlugins` entries from your settings files.[^claude-discover-plugins]
|
|
70
|
+
|
|
71
|
+
[^claude-discover-plugins]: Discover and install Claude Code plugins
|
|
72
|
+
[^claude-loading]: How Claude Code loads plugins
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: playbook
|
|
3
|
+
title: Installing from a script or CI
|
|
4
|
+
description: The claude plugin CLI installs and manages plugins from your shell, with user scope by default and a --yes flag for command-source prompts.
|
|
5
|
+
tags: [agents, claude-code, ci]
|
|
6
|
+
status: stable
|
|
7
|
+
generated: { by: claude-code/claude-opus-5-5, at: 2026-09-29T00:00:00Z }
|
|
8
|
+
stale_after: 2027-03-29T00:00:00Z
|
|
9
|
+
sources:
|
|
10
|
+
- id: claude-discover-plugins
|
|
11
|
+
resource: https://code.claude.com/docs/en/discover-plugins
|
|
12
|
+
title: Discover and install Claude Code plugins
|
|
13
|
+
author: team:anthropic
|
|
14
|
+
- id: claude-cli-reference
|
|
15
|
+
resource: https://code.claude.com/docs/en/plugins/cli-reference
|
|
16
|
+
title: Claude Code plugin CLI reference
|
|
17
|
+
author: team:anthropic
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Installing from a script or CI
|
|
21
|
+
|
|
22
|
+
Run `claude plugin` subcommands in your shell to install and manage
|
|
23
|
+
plugins without starting a Claude Code session, for example from a setup
|
|
24
|
+
script.[^claude-discover-plugins]
|
|
25
|
+
|
|
26
|
+
## Commands
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
claude plugin marketplace add <owner>/<repo>[#ref]
|
|
30
|
+
claude plugin install <plugin>@<marketplace>
|
|
31
|
+
claude plugin list
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
The marketplace must be added before you install from it.
|
|
35
|
+
|
|
36
|
+
## Scopes
|
|
37
|
+
|
|
38
|
+
`claude plugin install` installs at user scope by default. Pass
|
|
39
|
+
`--scope project` or `--scope local` to change it. `claude plugin
|
|
40
|
+
enable` and `claude plugin disable` act on the most specific scope whose
|
|
41
|
+
settings already list the plugin unless you pass `--scope`. See
|
|
42
|
+
[`claude-code-install-scopes.md`](claude-code-install-scopes.md) for what
|
|
43
|
+
each scope writes to.[^claude-cli-reference]
|
|
44
|
+
|
|
45
|
+
## The `--yes` flag
|
|
46
|
+
|
|
47
|
+
Some plugins install by running a command their marketplace names (a
|
|
48
|
+
`command` source). Claude Code shows the command and asks you to accept
|
|
49
|
+
it. A script has no one to answer, so pass `--yes` to accept that prompt.
|
|
50
|
+
`--yes` does not skip any other prompt.[^claude-cli-reference]
|
|
51
|
+
|
|
52
|
+
## When plugins load
|
|
53
|
+
|
|
54
|
+
Plugins you install from the shell load the next time you start Claude
|
|
55
|
+
Code, or when you run `/reload-plugins` in a session that is already
|
|
56
|
+
open.[^claude-discover-plugins]
|
|
57
|
+
|
|
58
|
+
[^claude-discover-plugins]: Discover and install Claude Code plugins
|
|
59
|
+
[^claude-cli-reference]: Claude Code plugin CLI reference
|