AGENTS.md said 12 pre-push hooks and recommended a command that reports 14, so a reader following the instruction hit a mismatch on the first try. The repo defines 12; pre-commit's own `meta` hooks, check-hooks-apply and check-useless-excludes, declare no `stages:` and therefore also run at pre-push. Refs #97 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X7GvKuJfy2WrdBmUttV4DT
7.4 KiB
Working in this repo
This repo is the global AI development configuration repository — the authoritative source for agent definitions, skills, workflows, and prompts across all projects. Built as a homelab tool intended to scale to professional environments.
Structure
plugins/— installable plugin units; each is an apm package (apm.yml+.apm/) carrying skills, agents, hooks, MCP servers, and bundled assets; install separately viaclaude plugin install <name>@holocronproviders/claude-code/— Claude Code adapter (deployed to~/.claude/viainstall.sh)
Edit .apm/, never the flat mirror
Inside a plugin, plugins/<name>/.apm/ is the only hand-edited content source. Everything else in a plugin root is generated:
scripts/sync-plugin-content.shgenerates the flatplugins/<name>/{skills,agents,commands,instructions,extensions}/directories and the mergedplugins/<name>/hooks/hooks.json(ADR-0017)apm packgenerates both per-plugin manifests —plugins/<name>/.claude-plugin/plugin.jsonandplugins/<name>/.github/plugin/plugin.json— and two of the three root marketplace manifests:.claude-plugin/marketplace.json(apm'sclaudeoutput profile) and.agents/plugins/marketplace.json(itscodexprofile, a differently-shaped file) (ADR-0015)scripts/sync-marketplace-mirror.shgenerates the third,.github/plugin/marketplace.json— Copilot CLI's legacy manifest path. No apm output profile targets it: apm ships exactly two marketplace output profiles,claudeandcodex(documented inplugins/kyberforge/.apm/skills/apm-workflow/references/marketplace.md). The mirror is a byte-identical copy of.claude-plugin/marketplace.json, gated by thecheck-marketplace-mirror-syncpre-push hook. Do not expectapm packto refresh it — that assumption is exactly the drift this pair exists to prevent
Nothing labels a generated file as generated — plugins/kyberforge/skills/forge/SKILL.md is byte-identical to its .apm/ original, with no marker in either. Check the path before you edit. An edit to the mirror is discarded by the next sync and is reported as drift by the check-plugin-content-sync pre-push hook, which is the earliest anyone finds out. Details in docs/spec/architecture.md.
Prefer plugin skills over raw shell
This repo dogfoods its own plugins. Before shelling out to git, gitea, or lint tooling directly, check whether an installed skill already owns the operation — it usually does:
- Commits, branches, history, worktrees, remotes →
git:git-commits,git:git-branches,git:git-history,git:git-worktrees,git:git-remotes - Pre-commit hook install/config/troubleshooting →
git:pc-run/git:pc-author - Issues, PRs, labels, milestones →
gitea:gitea-issues,gitea:gitea-prs,gitea:gitea-labels-milestones; alsogitea:gitea-branches,gitea:gitea-files,gitea:gitea-releases, orgitea:gitea-workflowwhen the domain is ambiguous - Vale prose linting →
lint:vale-config/lint:vale-run - This repo's own AGENTS.md →
core:agentsmd-author/core:agentsmd-audit
Fall back to raw shell only when no skill covers it.
Setup and testing
- Install git hooks via
git:pc-run, wiring all three stages — this repo's.pre-commit-config.yamlhas nodefault_install_hook_types, so a plain install silently skipscommit-msg(Conventional Commits) andpre-push(the 12-hook gate described below). - Install the
apmCLI — four pre-push hooks shell out to it:apm-marketplace-check,apm-audit-ci,apm-pack-check-clean, andcheck-plugin-content-sync(viascripts/sync-plugin-content.sh, which wrapsapm pack). The first three are bareapm …hook entries, so without it the push dies with an unhelpful "command not found". Usekyberforge:apm-install, orcurl -sSL https://aka.ms/apm-unix | sh; verify withapm --version. - Install
jq— required byscripts/check-manifests.shandscripts/sync-plugin-content.sh, both pre-push. These at least fail loudly (Error: jq is required but not installed). - Install the
valebinary — required by thevale-audit-prefilter-skill/-agentpre-commit hooks. Theirfiles:patterns are.apm/-scoped:^plugins/[^/]+/\.apm/skills/[^/]+/SKILL\.md$and^plugins/[^/]+/\.apm/agents/[^/]+\.agent\.md$. Only the authoring source triggers them — aSKILL.mdin the generated mirror matches neither pattern, so prose findings surface only when you edit the file you are supposed to be editing. Without the binary the hooks fail with a bare "command not found" and no install pointer.brew install vale(macOS),snap install vale(Linux),choco install vale(Windows), or see https://vale.sh/docs/vale-cli/installation/. Novale syncneeded — theKyberforgestyles are committed underplugins/kyberforge/.apm/skills/{skill-audit,agent-audit}/assets/vale/styles/, not downloaded packages (see ADR-0014). - Run
bash tests/run-tests.shbefore considering any change done — it runs everytest-*.shscript in the repo plus the bats suite (--bats-onlyfor just bats). First run auto-initializes the bats submodules; no manualgit submodule updateneeded. - Pushing runs 12 repo-defined pre-push hooks, not just the test suite —
run-testsandcheck-manifests, plus generated-content drift gates (check-plugin-content-sync,check-marketplace-mirror-sync,check-vale-style-sync,check-scope-walkup-sync), apm's own gates (apm-marketplace-check,apm-audit-ci,apm-pack-check-clean), host validators (validate-plugins,validate-marketplace, both needing theclaudeCLI), andcheck-release-needed. Runpre-commit run --hook-stage pre-push --all-fileslocally — one command, the whole gate. That command reports 14, not 12: pre-commit's ownmetahooks,check-hooks-applyandcheck-useless-excludes, declare nostages:and so run at every stage including this one. apm-marketplace-checkneeds the network. It resolves everymarketplace.packages[]entry including the remotemattpocock-skillsref, and it isalways_run, so an unreachable network hard-fails the push.--offlineis not an escape hatch — it still exits 1 on that entry (No cached refs (offline)). To push without a network, skip that one hook using pre-commit's own mechanism:SKIP=apm-marketplace-check git push. Skip that hook alone — it is the only one whose failure mode is "no network". Every other pre-push hook is a real local check, and adding it toSKIPdisarms it silently.- Author commits with
git:git-commits— it validates Conventional Commits (enforced atcommit-msg) for you.
Key documents
Read CONTEXT.md at the start of every session in this repo.
Read these on demand:
docs/spec/architecture.md— current directory structure, install pipeline, provider modeldocs/adr/— architectural decisions; read before answering design questions or proposing structural changesdocs/ai-constitution.md— full governance evidence base; read when a governance decision needs justificationdocs/research/ai-coding-factory/ai-coding-factory-principles.md— factory design rationale; read when implementing, auditing, or reviewing skills or factory structuredocs/notes/factory-integration-decisions.md— decisions from the factory integration grill; read when making skill authoring or factory design decisions- Governance rules are always in effect —
core/instructions/governance.md(agent rules);docs/research/governance_principles/CONTROLS.md