Project Files

Project files

aim-cli keeps project-local output in three places and can optionally store reusable sign-in state outside the project:

AGENTS.md contains the rendered instruction and profile content that your tools and collaborators read.
.aim-instructions.yaml tracks direct installs, profile ownership, and prompt file paths.
.aim-prompts/ stores installed prompts as local Markdown files.

Managed sections in AGENTS.md use simple tags based on the resource technical name:

<aim:general-developer-instructions>
...
</aim:general-developer-instructions>

The manifest keeps the matching ownership state for those blocks:

version: 1
instructions:
  - name: go-review
    profiles:
      - backend-review
profiles:
  - name: backend-review
    instructions:
      - go-review
prompts:
  - name: jira-project-status
    path: .aim-prompts/jira-project-status.md

info

Optional stored sign-in

If you opt in after logging in, aim-cli stores reusable credentials in ~/.aim-cli/auth.json. The file is outside the project so it does not become part of your repository.

warning

Keep the managed files in sync

aim-cli validates that managed block names and tracked prompt paths match the entries in .aim-instructions.yaml. If a file is missing or out of sync, the command stops with an error until the local state is repaired.