Pi Documentação
Pi é um conjunto mínimo de codificação de terminal. Ele foi projetado para permanecer pequeno no núcleo enquanto é estendido por meio de extensões TypeScript, habilidades, prompt templates, temas e pacotes pi.
Início rápido
Instale Pi com npm:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts desativa scripts de ciclo de vida de dependência durante a instalação. Pi não requer scripts de instalação para instalações normais do npm.
No Linux ou macOS, você também pode usar o instalador:
curl -fsSL https://pi.dev/install.sh | shPara desinstalar o próprio pi, use npm para instalações curl e npm:
npm uninstall -g @earendil-works/pi-coding-agentPara instalações 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 do projeto:
piAutentique com /login para subscription providers ou defina um API key como ANTHROPIC_API_KEY antes de iniciar o pi.
Para o fluxo completo da primeira execução, consulte Quickstart.
Comece aqui
- Quickstart - instale, autentique e execute uma primeira sessão.
- Using Pi - modo interativo, referência slash commands, context files e CLI.
- Providers - assinatura e configuração de API chave para provedores integrados.
- llama.cpp - execute um roteador local e gerencie modelos com
/llama. - Security - confiança do projeto, sandbox limites e relatórios de vulnerabilidade.
- Containerization - sandbox pi com Gondolin, Docker ou OpenShell.
- Settings - configurações globais e do projeto.
- Keybindings - atalhos padrão e combinações de teclas personalizadas.
- Sessions - gerenciamento de sessão, ramificação e navegação em árvore.
- Compaction - context compaction e branch summarization.
Personalização
- Extensions - TypeScript módulos para ferramentas, comandos, eventos e UI personalizada.
- Skills - Agente Skills para recursos reutilizáveis sob demanda.
- Prompt templates - prompts reutilizáveis que se expandem de slash commands.
- Themes - integrado e personalizado terminal themes.
- Pi packages - agrupe e compartilhe extensões, habilidades, prompts e temas.
- Custom models - adiciona entradas de modelo para provedores suportados APIs.
- Custom providers - implementa fluxos APIs e OAuth personalizados.
Uso programático
- SDK - incorpora pi em aplicativos Node.js.
- RPC mode - integra sobre stdin/stdout JSONL.
- JSON event stream mode - modo de impressão com eventos estruturados.
- TUI components - construa UI de terminal personalizada para extensões.
Referência
- Environment variables - Pi configuração do processo e metadados de sessão disponíveis para ferramentas bash.
- Session format - JSONL formato de arquivo de sessão, tipos de entrada e SessionManager API.
Configuração da plataforma
Desenvolvimento
- Development - configuração local, estrutura do projeto e depuração.