Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ami.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Adding a Project

Navigate to the root directory of your repository and run: 
ami project add
This registers the folder as a project. Run ami to open the chat interface. Alternatively, running ami in an unregistered repository automatically prompts you to create a project.

​
Switching Projects

​
From the Terminal

Navigate to a registered project’s folder and run ami. This automatically opens the correct project in the interface.

​
From the Interface

Press Cmd+K to open the command palette and search for a project by name. Alternatively, click the project name in the sidebar to view all your projects.

​
Project Rules

ami looks for guidance files in your codebase to understand project structure, conventions, and commands.

​
Supported Files

ami reads all of the following files if they exist. Contents are combined and deduplicated:
FilePurpose
AGENTS.mdAgent guidance file
CLAUDE.mdClaude-style guidance file
GEMINI.mdGemini-style guidance file
.cursor/rulesCursor rules (file or directory)
Put your build commands, test commands, code conventions, and architecture notes in these files. ami reads them automatically.

​
Example AGENTS.md

# Project Overview

This is a Next.js 14 app with TypeScript and Tailwind.

## Commands

- `pnpm dev` - Start development server
- `pnpm build` - Build for production
- `pnpm test` - Run tests
- `pnpm lint` - Run ESLint

## Conventions

- Use TypeScript interfaces over types
- Use arrow functions
- Components go in `src/components/`
- API routes go in `src/app/api/`
Include lint commands in AGENTS.md. ami runs them automatically after making changes if it knows what commands to use.