Pi Documentación
Pi es un arnés de codificación de terminal mínimo. Está diseñado para permanecer pequeño en su núcleo mientras se amplía a través de TypeScript extensiones, habilidades, prompt templates, temas y paquetes pi.
Inicio rápido
Instale 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 requiere scripts de instalación para instalaciones normales npm.
En Linux o macOS, también puedes utilizar el instalador:
curl -fsSL https://pi.dev/install.sh | shPara desinstalar pi, use npm para curl y npm instala:
npm uninstall -g @earendil-works/pi-coding-agentPara instalaciones pnpm, Yarn o Bun, utilice el comando de eliminación global 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.
Luego ejecútelo en un directorio de proyecto:
piAutentíquese con /login para subscription providers, o establezca un API key como ANTHROPIC_API_KEY antes de iniciar pi.
Para conocer el flujo completo de la primera ejecución, consulte Quickstart.
Empieza aquí
- Quickstart: instala, autentica y ejecuta una primera sesión.
- Using Pi - modo interactivo, referencia slash commands, context files y CLI.
- Providers: suscripción y configuración de clave API para proveedores integrados.
- llama.cpp: ejecuta un enrutador local y administra modelos con
/llama. - Security: confianza en el proyecto, sandbox límites e informes de vulnerabilidad.
- Containerization - sandbox pi con Gondolin, Docker o OpenShell.
- Settings - configuración global y del proyecto.
- Keybindings: atajos predeterminados y combinaciones de teclas personalizadas.
- Sessions: gestión de sesiones, ramificación y navegación en árbol.
- Compaction - context compaction y branch summarization.
Personalización
- Extensions - TypeScript módulos para herramientas, comandos, eventos y UI personalizada.
- Skills: Agente Skills para capacidades reutilizables bajo demanda.
- Prompt templates: indicaciones reutilizables que se expanden desde slash commands.
- Themes: integrado y personalizado terminal themes.
- Pi packages: agrupa y comparte extensiones, habilidades, indicaciones y temas.
- Custom models: agrega entradas de modelo para el proveedor compatible APIs.
- Custom providers: implemente flujos API y OAuth personalizados.
Uso programático
- SDK: incrusta pi en las aplicaciones Node.js.
- RPC mode - integrar sobre stdin/stdout JSONL.
- JSON event stream mode - modo de impresión con eventos estructurados.
- TUI components: crea una interfaz de usuario de terminal personalizada para extensiones.
Referencia
- Environment variables - Pi configuración del proceso y metadatos de sesión disponibles para las herramientas bash.
- Session format - JSONL formato de archivo de sesión, tipos de entrada y SessionManager API.
Configuración de la plataforma
Desarrollo
- Development: configuración local, estructura del proyecto y depuración.