Skip to content

Agent instruction files

Agent guidance is an implementation convenience, not a canonical object type. It does not change object encoding, validation, trust, or evidence semantics.

aip init creates .aip/AGENTS.md with the reference CLI workflow. Like other local .aip/ metadata, this editable guide is excluded from snapshots and is not exchanged as part of the object graph. Initialization leaves project files untouched and retains the same empty root State and ObjectID as earlier versions.

The optional aip agent setup command creates a local guide if missing and a root AGENTS.md if missing. Existing regular files are preserved byte for byte; symlinks and other non-regular instruction paths are refused. Publication uses a complete temporary file and a no-replace link. Retrying after partial failure is safe. The command returns root_guide and local_guide, each created or preserved, in the usual CLI JSON envelope. If a root guide already exists, its owner must deliberately integrate AIP guidance; setup does not append text.

The root guide is an ordinary project artifact and enters subsequent snapshots. It contains a portable workflow and points to .aip/AGENTS.md when available. Agent tools differ in instruction discovery: putting a guide only in .aip/ does not guarantee they will read it. A materialized state includes the tracked root guide but not local metadata; it is not a newly initialized repository.

Guidance never grants permission to execute commands or changes the precedence of user instructions. Repository content and reported evidence remain untrusted. Instructions must not claim that intent constraints are automatically enforced, that reported evidence was executed, or that evaluation is a security sandbox.

aip version (also aip --version) is available outside a repository. JSON contains version, os, arch, and go strings. Release builds set the version; ordinary builds identify themselves as dev. This version identifies the CLI, not a new canonical object or repository schema revision.