Skip to content

Repo Guidance for Agents

When an AI agent works in Cabloy, it should navigate the repo with deliberate layers of trust.

1. Start from the root

Check the root repository signals first:

  • package.json
  • edition marker files such as __CABLOY_BASIC__ or __CABLOY_START__
  • repo-docs-internal/
  • repo-specs/ when the task concerns a suite plan, WBS increment, acceptance record, or evidence
  • root .claude/ assets

These surfaces tell the agent which repo it is in and which scripts are canonical. Inspect relevant repo-docs-internal/ records as supporting context rather than as a gate to workflow guidance.

2. Prefer framework entrypoints over scattered examples

For backend workflows:

  • start from npm run vona
  • inspect Vona CLI command families

For frontend workflows:

  • start from npm run zova
  • inspect Zova CLI command families

This is more reliable than copying old file structures from examples without understanding the command surface that created them.

3. Use public docs, suite records, and internal notes for different purposes

  • use repo-docs/ to explain how people and agents should work
  • use repo-specs/<suite>/ for suite-local product, technical, delivery, ATP, progress, ADR, and observed-evidence authority
  • use repo-docs-internal/ for supporting maintainer rationale
  • continue from public docs, rules, skills, source, and tests when a specific internal record is unavailable or irrelevant; do not create a replacement document implicitly

For planning work, read the suite README, PRD, SRS, WBS, test plan, and progress records in the order appropriate to the task. cabloy-spec-generation maintains planning authority; cabloy-spec-execution acts only on a confirmed, bounded WBS increment. Both require active-source and edition discovery before topology or command claims.

4. Treat edition detection as mandatory for UI-sensitive work

Edition detection is especially important when the work touches:

  • page creation
  • component generation
  • UI-layer usage
  • frontend flavor scripts
  • edition-specific suites, modules, SSR site baselines, or project assets

5. Use the right lookup surface before searching broadly

For backend lookup work, choose the surface before choosing the files:

  • if code references this.bean.xxx, ctx.bean.xxx, or app.bean.xxx, start from IBeanRecordGlobal and module src/.metadata/index.ts
  • if code references a full bean name, inspect IBeanRecordGeneral
  • if the target is a runtime-anchor or selector/class-token service, inspect src/service and service metadata
  • if the target is only a helper or superclass chain, inspect src/lib

This reduces wasted search and keeps bean lookup aligned with class placement.

6. Verify before claiming success

Whenever a workflow recommendation is made, verify it against current scripts or command definitions before presenting it as guidance.

Released under the MIT License.