Início rápido

Esta página leva você da instalação até uma primeira sessão útil com o pi.

Pi é distribuído como um pacote npm:

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

--ignore-scripts desativa scripts de ciclo de vida das dependências durante a instalação. Pi não precisa de scripts de instalação para instalações npm normais.

Use o gerenciador de pacotes que instalou o pi. O instalador curl usa npm globalmente, então instalações feitas com curl ou npm são removidas com npm:

# curl installer or npm install -g
npm uninstall -g @earendil-works/pi-coding-agent

# pnpm
pnpm remove -g @earendil-works/pi-coding-agent

# Yarn
yarn global remove @earendil-works/pi-coding-agent

# Bun
bun uninstall -g @earendil-works/pi-coding-agent

Ao desinstalar o pi, configurações, credenciais, sessões e pacotes pi instalados permanecem em ~/.pi/agent/.

Depois, inicie o pi no diretório do projeto em que você quer que ele trabalhe:

cd /path/to/project
pi

Pi pode usar provedores por assinatura via /login, ou provedores com API key via variáveis de ambiente ou arquivo de autenticação.

Inicie o pi e execute:

/login

Depois selecione um provedor. Os logins por assinatura integrados incluem Claude Pro/Max, ChatGPT Plus/Pro (Codex) e GitHub Copilot.

Defina uma API key antes de iniciar o pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Você também pode executar /login e selecionar um provider com API key para armazenar a chave em ~/.pi/agent/auth.json.

Consulte Providers para ver todos os provedores compatíveis, variáveis de ambiente e configuração de provedores cloud.

Quando o pi iniciar, digite uma solicitação e pressione Enter:

Summarize this repository and tell me how to run its checks.

Por padrão, pi fornece quatro ferramentas ao modelo:

• read - ler arquivos
• write - criar ou sobrescrever arquivos
• edit - alterar arquivos por patch
• bash - executar comandos Shell

Ferramentas integradas adicionais somente leitura (grep, find, ls) ficam disponíveis pelas opções de ferramentas. Pi roda no diretório de trabalho atual e pode modificar arquivos ali. Use Git ou outro fluxo de checkpoint se quiser reverter mudanças facilmente.

Pi carrega context files na inicialização. Adicione um arquivo AGENTS.md para dizer como ele deve trabalhar em um projeto:

# Project Instructions

- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.

Pi carrega:

• ~/.pi/agent/AGENTS.md para instruções globais
• AGENTS.md ou CLAUDE.md dos diretórios pais e do diretório atual

Se um diretório contiver AGENTS.override.md, Pi carrega esse arquivo em vez de AGENTS.md ou CLAUDE.md desse diretório.

Reinicie o pi, ou execute /reload, depois de alterar context files.

Digite @ no editor para buscar arquivos por fuzzy search, ou passe arquivos pela linha de comando:

pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"

Imagens ou texto podem ser colados com Ctrl+V (Alt+V no Windows); imagens também podem ser arrastadas para terminais compatíveis.

No modo interativo:

!npm run lint

A saída do comando é enviada ao modelo. Use !!command para executar um comando sem adicionar sua saída ao contexto do modelo.

Use /model ou Ctrl+L para escolher um modelo. Use Shift+Tab para alternar o thinking level. Use Ctrl+P / Shift+Ctrl+P para percorrer scoped models.

As sessões são salvas automaticamente:

pi -c                  # Continue most recent session
pi -r                  # Browse previous sessions
pi --name "my task"    # Set session display name at startup
pi --session <path|id> # Open a specific session

Dentro do pi, use /resume, /new, /tree, /fork e /clone para gerenciar sessões.

Para prompts pontuais:

pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"

Use --mode json para saída de eventos JSON ou --mode rpc para integração com processos.

• Using Pi - modo interativo, slash commands, sessões, context files e referência de CLI.
• Providers - autenticação e configuração de modelos.
• Settings - configuração global e de projeto.
• Keybindings - atalhos e personalização.
• Pi Packages - instalar Extensions, Skills, Prompts e Themes compartilhados.

Notas da plataforma: Windows, Termux, tmux, Terminal setup, Shell aliases.