Início rápido

Esta página leva você desde a instalação até uma primeira sessão útil do 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 de dependência durante a instalação. Pi não requer scripts de instalação para instalações normais do npm.

Use o gerenciador de pacotes que instalou o pi. O instalador curl usa npm globalmente, então as instalações curl e 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

A desinstalação do pi deixa configurações, credenciais, sessões e pacotes pi instalados em ~/.pi/agent/.

Em seguida, inicie o pi no diretório do projeto em que deseja que ele funcione:

cd /path/to/project
pi

Pi pode usar provedores de chave subscription providers a /login ou API por meio de variáveis ​​de ambiente ou do arquivo de autenticação.

Inicie pi e execute:

/login

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

Defina um API key antes de iniciar o pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

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

Consulte Providers para todos os provedores suportados, variáveis ​​de ambiente e configuração do provedor de nuvem.

Assim que 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 ao modelo quatro ferramentas:

• read - lê arquivos
• write - cria ou sobrescreve arquivos
• edit - corrigir arquivos
• bash - executa comandos shell

Ferramentas adicionais somente leitura integradas (grep, find, ls) estão disponíveis através de opções de ferramentas. Pi é executado em seu diretório de trabalho atual e pode modificar arquivos lá. Use git ou outro fluxo de trabalho de checkpoint se desejar uma reversão fácil.

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

# Project Instructions

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

Pi cargas:

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

Se um diretório contém AGENTS.override.md, Pi carrega-o em vez de AGENTS.md ou CLAUDE.md desse diretório.

Reinicie o pi ou execute /reload, após alterar context files.

Digite @ no editor para pesquisar arquivos difusos ou passe os arquivos na 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); as imagens também podem ser arrastadas para terminais suportados.

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 nível de pensamento. Use Ctrl+P / Shift+Ctrl+P para percorrer os modelos com escopo definido.

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 solicitações únicas:

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 evento JSON ou --mode rpc para integração de processos.

• Using Pi - modo interativo, slash commands, sessões, context files e CLI referência.
• Providers - autenticação e configuração do modelo.
• Settings - configuração global e do projeto.
• Keybindings - atalhos e personalização.
• Pi Packages - instale extensões, habilidades, prompts e temas compartilhados.

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