Documentação do Pi

Pi é um framework minimalista de coding Agent para o terminal. O núcleo permanece pequeno e pode ser estendido com extensões TypeScript, Skills, Prompt Templates, Themes e Pi Packages.

Instale o Pi com npm:

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

--ignore-scripts desativa os scripts do ciclo de vida das dependências durante a instalação. O Pi não exige scripts de instalação em instalações normais com npm.

No Linux ou macOS, você também pode usar o instalador:

curl -fsSL https://pi.dev/install.sh | sh

Para desinstalar o próprio Pi quando ele foi instalado pelo instalador curl ou por npm, use npm:

npm uninstall -g @earendil-works/pi-coding-agent

Para instalações com pnpm, Yarn ou Bun, use o comando de remoção global correspondente: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent ou bun uninstall -g @earendil-works/pi-coding-agent.

Em seguida, execute-o em um diretório de projeto:

pi

Para Provider por assinatura, autentique-se com /login; para Provider com API key, defina uma chave como ANTHROPIC_API_KEY antes de iniciar o pi.

Consulte Quickstart para ver o fluxo completo da primeira execução.

• Quickstart - instale, autentique-se e inicie uma primeira sessão.
• Using Pi - modo interativo, slash commands, context files e referência da CLI.
• Providers - configuração de assinatura e API key para Provider integrados.
• llama.cpp - execute um roteador local e gerencie modelos com /llama.
• Security - confiança do projeto, limites da sandbox e relatório de vulnerabilidades.
• Containerization - isole o pi em uma sandbox com Gondolin, Docker ou OpenShell.
• Settings - configurações globais e de projeto.
• Keybindings - atalhos padrão e keybindings personalizados.
• Sessions - gerenciamento de sessões, branches e navegação em árvore.
• Compaction - compactação de contexto e resumos de branches.

• Extensions - módulos TypeScript para ferramentas, comandos, eventos e UI personalizada.
• Skills - Agent Skills para recursos reutilizáveis sob demanda.
• Prompt templates - prompts reutilizáveis expandidos a partir de slash commands.
• Themes - temas de terminal integrados e personalizados.
• Pi packages - agrupe e compartilhe extensões, Skills, prompts e temas.
• Custom models - adicione entradas de modelo para APIs de Provider compatíveis.
• Custom providers - implemente APIs e fluxos OAuth personalizados.

• SDK - incorpore o pi em aplicações Node.js.
• RPC mode - integre por stdin/stdout JSONL.
• JSON event stream mode - print mode com eventos estruturados.
• TUI components - crie uma UI de terminal personalizada para extensões.

• Environment variables - configuração de processo do Pi e metadados de sessão disponíveis para ferramentas bash.
• Session format - formato de arquivo de sessão JSONL, tipos de entrada e API SessionManager.

• Windows
• Termux on Android
• tmux
• Terminal setup
• Shell aliases

• Development - configuração local, estrutura do projeto e depuração.