DOCUMENTATION / GETTING STARTED

Install AIPI and connect a repository

The companion runs beside your code, configures local MCP clients, and keeps source, credentials, payloads, and evidence on your machine.

Requirements

  • Node.js 22 or newer.
  • A local Git repository.
  • Codex, Cursor, VS Code, or another MCP-capable client.

Initialize the repository

Run the initializer from the repository root. No global installation is required.

cd /path/to/your/project
npx @vmise/aipi-companion@latest init

AIPI creates .aipirc.json, detects common source roots, adds project-local MCP entries, and starts or reuses the local companion.

Check the connection

npx @vmise/aipi-companion@latest status
npx @vmise/aipi-companion@latest doctor --root .

Reload the IDE after the first setup and accept its project trust prompt if shown.

Open the workspace

Codex

Ask: Open my AIPI workspace. The installed MCP App opens in the toggleable tool side panel, without a copied browser URL.

VS Code or Cursor

Open the AIPI Activity Bar view, or run AIPI: Open Workspace in Editor from the command palette.

Browser fallback: aipi open remains available for local development and troubleshooting.