sklpdocs

sklp agents-md

sklp agents-md [flags]

Description

Generates a section of AGENTS.md from .sklp/deploy-root.yaml, .sklp/image-watches.yaml and the pipelines: what core reconciles from main, which images roll on publish, and when `sklp deploy apply` is (not) the way. Only the marked section is rewritten. A CLAUDE.md without `@AGENTS.md` gets that import appended. --check fails when the section is stale, for a git hook.

Flags

FlagAliasesTypeDefaultEnvDescription
--repo—string.—repository root
--check—bool——exit 1 when AGENTS.md is out of date, write nothing

Technical details

Technical details

Raw command JSON

{
  "path": [
    "sklp",
    "agents-md"
  ],
  "slug": "agents-md",
  "name": "agents-md",
  "short": "Write this repo's deploy facts into AGENTS.md so AI agents know how it ships",
  "long": "Generates a section of AGENTS.md from .sklp/deploy-root.yaml, .sklp/image-watches.yaml\nand the pipelines: what core reconciles from main, which images roll on publish, and\nwhen `sklp deploy apply` is (not) the way. Only the marked section is rewritten.\nA CLAUDE.md without `@AGENTS.md` gets that import appended. --check fails when\nthe section is stale, for a git hook.",
  "synopsis": "sklp agents-md [flags]",
  "flags": [
    {
      "name": "repo",
      "usage": "repository root",
      "type": "string",
      "default": "."
    },
    {
      "name": "check",
      "usage": "exit 1 when AGENTS.md is out of date, write nothing",
      "type": "bool"
    }
  ]
}

See also