Cell API
    Preparing search index...

    Class AgentGuide

    The agent guide of a project (docs/design/agent-first.md R7): the Cell guide of the installed @celljs/cli version, followed by the AGENTS.md snippets of the installed components and toolchain modules. It is written between markers in AGENTS.md, so the rest of the file stays the project's, and as the skill .agents/skills/cell/SKILL.md.

    Index
    constructor
    root version BEGIN END GUIDE SKILL
    content sync write snippets
    root: string
    version: string
    BEGIN: "<!-- cell:begin (generated by `cell agent sync`; edit outside these markers) -->" = '<!-- cell:begin (generated by `cell agent sync`; edit outside these markers) -->'
    END: "<!-- cell:end -->" = '<!-- cell:end -->'
    GUIDE: URL = ...
    SKILL: ".agents/skills/cell/SKILL.md" = '.agents/skills/cell/SKILL.md'

    content

    • AGENTS.md of the components (not the project's own) and of module docs directories.

      Parameters

      • components: readonly { dir: string; name: string; root: boolean }[]
      • moduleDocs: readonly { source: string; value: string }[]

      Returns GuideSnippet[]

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods