Getting Started

Getting started

Use aim-cli when you want to pull approved instructions, profiles, or prompts from A.I.M. into local project files without manually copying or formatting content.

Install a single instruction

bash — install an instruction

$~/projectaim-cli instruction install general-developer-instructions

? Email: user@example.com

? Password:

? Store login for future commands [y/N]: y

Select tenant

1 Acme

? Tenant number [1-1]: 1

Installed instruction general-developer-instructions in AGENTS.md.

After the command finishes, aim-cli writes a managed block into AGENTS.md, records the install in .aim-instructions.yaml, and can reuse the stored login on later authenticated commands if you opted in.

Install a prompt file

bash — install a prompt

$~/projectaim-cli prompt install jira-project-status

? Tenant number [1-1]: 1

Installed prompt jira-project-status in .aim-prompts/jira-project-status.md.

Prompt installs create or refresh a tracked Markdown file under .aim-prompts and store the path in .aim-instructions.yaml. Profile installs work the same way as instruction installs, but add a profile summary block and the included instruction blocks together.

Review local changes and open a proposal

bash — diff and create a pull request

$~/projectaim-cli pr diff all

diff --git a/.aim-prompts/jira-project-status.md b/.aim-prompts/jira-project-status.md

$~/projectaim-cli pr create prompt jira-project-status

? Commit message: feat: improve jira project status prompt

Created pull request for prompt jira-project-status.

Use the pull-request commands to compare your local instruction, profile, or prompt changes with the accepted tenant version before proposing a create, update, or delete change.

Review current state

bash — check status

$~/projectaim-cli status

AGENTS status for AGENTS.md

Profiles

Instructions

Use aim-cli status to see which profiles are installed, which instructions are present, and whether each instruction is direct, profile-managed, or both. This command only reads local files and does not prompt for credentials.