Skip to content

Repo Layout

github-actions[bot] edited this page Jun 10, 2026 · 2 revisions

Repo layout

What lives where in the crickets repo.

crickets/
├── src/                # SOURCE OF TRUTH — src/<group>/ (group.yaml + skills/ agents/ commands/ hooks/ scripts/)
├── dist/               # GENERATED native plugins (committed) — dist/<host>/plugins/<group>/
│   ├── claude-code/    #   + .claude-plugin/marketplace.json
│   └── antigravity/    #   + .agents/plugins/marketplace.json
├── .claude-plugin/     # repo-root marketplace pointer (`claude plugin marketplace add alexherrero/crickets`)
├── .agents/plugins/    # repo-root Antigravity marketplace pointer
├── scripts/            # generate.py (+ emit_*), lint_src.py, src_model.py, check-* gates, tests
├── bootstrap.sh        # one-line installer (curl | bash)
├── templates/          # scaffolding (e.g. hooks/pre-push)
├── wiki/               # the docs — get-started/ do/ reference/ plugins/ why/ designs/ decisions/
├── AGENTS.md           # universal instructions for any AGENTS.md-aware host
└── CLAUDE.md           # Claude Code entry point — points back at AGENTS.md

The two trees that matter

  • src/<group>/ is where you work — one folder per plugin, primitives inside. Plugin anatomy covers the shape; Manifest schema the contracts.
  • dist/<host>/plugins/<group>/ is what ships — generated, committed, and drift-gated (generate.py check fails CI if it doesn't match a fresh build). Never hand-edit it; the loop is always edit src/python3 scripts/generate.py build → commit both (Modify a plugin).

Everything else

  • scripts/ — the generator and the gate battery (check-all.sh runs it all — CI gates).
  • .claude-plugin/ + .agents/plugins/ — the repo-root marketplace pointers each host reads.
  • bootstrap.sh — installs the recommended plugin set in one line; only ever calls the hosts' native plugin install.
  • templates/hooks/pre-push — the PII enforcer a clone copies into .git/hooks/ (CONTRIBUTING).
  • wiki/ — this documentation, published to the GitHub wiki on every push (Wiki design).

Related

Clone this wiki locally