Skip to content

Clarify agent skill activation onboarding #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stef-k merged 2 commits into from
Aug 27, 2026
Merged

Clarify agent skill activation onboarding #113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b7df96
WIP: clarify agent skill activation prompt (checkpoint)
stef-k Aug 27, 2026
02d0eee
Clarify agent adoption prompt
stef-k Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,28 @@ environment, uv, and developer alternatives.

Copy this prompt to a coding agent:

> Consult the official Agent Code Guard repository and documentation. Install
> the published distribution in an isolated supported way, preferably with
> pipx; verify `code-guard --version` and run `code-guard doctor`. Locate the
> installed version-matched skill with `code-guard --skill-path`, and use or
> export only that skill through the documented mechanism. Inspect this
> repository without creating a LOC baseline and use changed-work scope. Ask
> before exporting into a persistent skill directory, changing persistent
> agent or platform configuration, or configuring hooks.
> Never weaken thresholds, exclusions, configuration, or baselines merely to
> silence findings.
> Adopt Agent Code Guard for this repository using the official project and
> documentation at https://github.com/stef-k/agent-code-guard. This prompt
> authorizes installing the published distribution in an isolated supported
> way, preferably with `pipx install agent-code-guard`, and persistently
> activating or exporting its installed, version-matched skill for the current
> agent environment. Verify `code-guard --version` and run `code-guard doctor`,
> then locate the skill with `code-guard --skill-path`. Follow the
> [skill activation guide](https://github.com/stef-k/agent-code-guard/blob/main/docs/skill-distribution.md):
> activate that installed path when the platform supports it, or export it with
> `code-guard --export-skill <target-directory>` to the platform's documented
> skill directory. Do not guess a target or overwrite an existing export; verify
> that `.agent-code-guard-version` matches the installed distribution. Follow the
> [agent workflow](https://github.com/stef-k/agent-code-guard/blob/main/docs/agent-workflow.md)
> without creating a LOC baseline. After meaningful source or Markdown edits, run
> `code-guard . --changed-only --json --json-mode compact`; outside Git, pass the
> exact edited files. Inspect REVIEW and FAIL findings, make only genuine
> improvements, rerun the check, and report the result. Never weaken thresholds,
> exclusions, configuration, or baselines merely to silence findings. Code Guard
> does not install or enable hooks by default. Ask before configuring a post-edit
> or post-turn hook, or making unrelated persistent agent or platform changes.
> Finish by reporting the installed version, doctor status, activated skill
> location, first analysis result, and any REVIEW findings you accepted.

## Five-minute start

Expand Down
Loading