Skip to content

API Reference

The dotagents package is a CLI umbrella plus a set of _*.py helper modules that form its API. Generated from docstrings, organized by module:

  • CLI — the dotagents.cli package: the Dotagents umbrella, main(), and command discovery.
  • Agents — the agent registry: the Agent base type and identity stamping.
  • Overlays — installing an overlay's files and collecting its AGENTS.md contributions; setup-script discovery and the manifest reader.
  • Scope — scope and overlay-source resolution for the overlays command.
  • Context — assembling the effective context for agents.
  • Environment — chained env-file assembly and env.py execution.
  • Resolution — the precedence walk / filename resolution (Contract A).
  • Merge — the managed-block merge for init's AGENTS.md / CLAUDE.md, and for other comment syntaxes (e.g. TOML) via begin_marker/ end_marker/append.
  • Hooks — additive, idempotent merge of dotagents' hooks into an agent's own settings/config file.
  • Skills — publishing an overlay's skills into a scope's shared dir.
  • Sync — the PathSyncer backup/copy wrapper for install.