Agent Doc Init
Initialize missing baseline policy documents with a non-destructive default.
Contract
Prereqs:
agent-docsavailable onPATH.bashandpython3available onPATH.- Write permission to target paths only when
--applyis used.
Inputs:
- Entrypoint:
$AGENT_HOME/skills/tools/agent-doc-init/scripts/agent_doc_init.sh. - Optional flags:
--dry-run(default mode)--apply(write mode)--force(overwrite baseline docs; requires--apply)--target all|home|project(default:all)--project-path <path>--agent-home <path>--project-required <context:path[:notes]>(repeatable)
Outputs:
- Deterministic summary lines to stdout.
- Baseline checks before/after initialization.
- Optional baseline scaffolding (
scaffold-baseline --missing-onlyby default). - Project-doc hydration for baseline templates (
AGENTS.md,DEVELOPMENT.md) using detected repo context (CI workflows, Formula files, git remote). - Optional project extension upserts via
agent-docs add.
Exit codes:
0: success (including no-op)1: runtime/dependency failure2: usage/safety contract violation
Failure modes:
agent-docsis missing fromPATH.- Invalid
--project-requiredformat or unsupported context. --forceis provided without--apply.agent-docsreports config/schema/runtime failures.- Template-only baseline docs remain after hydration in apply mode.
- File permission errors when writing during apply mode.
Scripts (only entrypoints)
$AGENT_HOME/skills/tools/agent-doc-init/scripts/agent_doc_init.sh
Workflow
- Run baseline check (
agent-docs baseline --check) and capture missing counts. - If required docs are missing (or force mode is requested), run
scaffold-baseline:- default:
--missing-only - overwrite path:
--force(only when explicitly requested)
- default:
- Hydrate baseline template docs into project-aware content (dry-run: plan only; apply: write).
- Optionally upsert project extension docs via
agent-docs addfor each--project-required. - Re-run baseline check and emit deterministic summary (including
doc_hydration+template_guard).
Safety defaults
- Dry-run by default (
--applyis required for writes). - No overwrite unless
--forceis explicitly provided. - Missing-only scaffold is the default write behavior.
- Apply mode enforces template guard for project docs (fails if template-only docs remain).
- All actions are idempotent when rerun with the same inputs.
Usage
Preview only:
$AGENT_HOME/skills/tools/agent-doc-init/scripts/agent_doc_init.sh \
--dry-run \
--project-path /path/to/repo
Apply missing baseline docs:
$AGENT_HOME/skills/tools/agent-doc-init/scripts/agent_doc_init.sh \
--apply \
--project-path /path/to/repo
Apply and add one project extension required doc:
$AGENT_HOME/skills/tools/agent-doc-init/scripts/agent_doc_init.sh \
--apply \
--project-path /path/to/repo \
--project-required "project-dev:BINARY_DEPENDENCIES.md:External runtime tools"
