Documentación de Pi
Pi es un framework minimalista de coding Agent para la terminal. Su núcleo se mantiene pequeño y se amplía mediante extensiones de TypeScript, Skills, Prompt Templates, Themes y Pi Packages.
Inicio rápido
Instala Pi con npm:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts deshabilita los scripts del ciclo de vida de las dependencias durante la instalación. Pi no necesita scripts de instalación en instalaciones normales con npm.
En Linux o macOS también puedes usar el instalador:
curl -fsSL https://pi.dev/install.sh | shPara desinstalar Pi instalado mediante el instalador de curl o npm, usa npm:
npm uninstall -g @earendil-works/pi-coding-agentPara instalaciones con pnpm, Yarn o Bun, usa el comando global de eliminación correspondiente: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent o bun uninstall -g @earendil-works/pi-coding-agent.
Después, ejecútalo desde un directorio de proyecto:
piPara los Provider por suscripción, autentícate con /login; para los Provider con API key, configura una como ANTHROPIC_API_KEY antes de iniciar pi.
Consulta Quickstart para ver el flujo completo de la primera ejecución.
Empieza aquí
- Quickstart - instala, autentica e inicia una primera sesión.
- Using Pi - modo interactivo, slash commands, context files y referencia de CLI.
- Providers - configuración de suscripciones y API key para los Provider integrados.
- llama.cpp - ejecuta un router local y administra modelos con
/llama. - Security - confianza del proyecto, límites de sandbox e informes de vulnerabilidades.
- Containerization - aísla pi en una sandbox con Gondolin, Docker u OpenShell.
- Settings - configuración global y de proyecto.
- Keybindings - atajos predeterminados y keybindings personalizados.
- Sessions - gestión de sesiones, ramas y navegación por el árbol.
- Compaction - compactación de contexto y resúmenes de ramas.
Personalización
- Extensions - módulos TypeScript para herramientas, comandos, eventos y UI personalizada.
- Skills - Agent Skills para capacidades reutilizables bajo demanda.
- Prompt templates - prompts reutilizables que se expanden desde slash commands.
- Themes - temas de terminal integrados y personalizados.
- Pi packages - agrupa y comparte extensiones, Skills, prompts y temas.
- Custom models - añade entradas de modelo para las API de Provider compatibles.
- Custom providers - implementa API y flujos OAuth personalizados.
Uso programático
- SDK - incorpora pi en aplicaciones Node.js.
- RPC mode - integra mediante stdin/stdout JSONL.
- JSON event stream mode - print mode con eventos estructurados.
- TUI components - crea una UI de terminal personalizada para extensiones.
Referencia
- Environment variables - configuración de proceso de Pi y metadatos de sesión disponibles para herramientas bash.
- Session format - formato de archivo de sesión JSONL, tipos de entrada y API de SessionManager.
Configuración de plataforma
Desarrollo
- Development - configuración local, estructura del proyecto y depuración.