30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# pc-run
|
|
|
|
Runs, installs, updates, and maintains pre-commit hooks in a local git clone.
|
|
|
|
## What it does
|
|
|
|
`pc-run` handles everything that happens *after* `.pre-commit-config.yaml` exists: wiring hooks into git, running them, bumping their versions, and maintaining the cache. When hooks fail, it identifies the cause and suggests a concrete fix — it does not auto-fix files or edit the config. For creating or editing `.pre-commit-config.yaml`, use `pc-author` instead.
|
|
|
|
## Before you start
|
|
|
|
- `pre-commit` must be installed and available on `PATH`
|
|
- A `.pre-commit-config.yaml` must exist at the repo root (use `pc-author` to create one)
|
|
|
|
## Usage
|
|
|
|
Common invocations:
|
|
- `/pc-run` — run all hooks against all files (default)
|
|
- `/pc-run install` — wire hooks into `.git/hooks/`
|
|
- `/pc-run autoupdate` — bump all `rev` values to latest
|
|
- `/pc-run clean` — wipe the pre-commit cache (requires confirmation)
|
|
|
|
## Files
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| `SKILL.md` | Skill instructions for agents |
|
|
| `references/failure-patterns.md` | Hook failure causes and concrete fix suggestions |
|
|
| `references/sources.md` | Provenance: research sources that informed this skill |
|
|
| `references/README.md` | Directory index for references/ |
|