Inicio rápido

Esta página le lleva desde la instalación hasta una útil primera sesión de pi.

Pi se distribuye como un paquete 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.

Utilice el administrador de paquetes que instaló pi. El instalador de curl usa npm globalmente, por lo que las instalaciones de curl y npm se eliminan con 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

La desinstalación de pi deja la configuración, las credenciales, las sesiones y los paquetes de pi instalados en ~/.pi/agent/.

Luego inicie pi en el directorio del proyecto en el que desea que funcione:

cd /path/to/project
pi

Pi puede usar proveedores de claves subscription providers hasta /login, o API a través de variables de entorno o el archivo de autenticación.

Inicie pi y ejecute:

/login

Luego seleccione un proveedor. Los inicios de sesión de suscripción integrados incluyen Claude Pro/Max, ChatGPT Plus/Pro (Codex) y GitHub Copilot.

Establece un API key antes de iniciar pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

También puede ejecutar /login y seleccionar un proveedor de claves API para almacenar la clave en ~/.pi/agent/auth.json.

Consulte Providers para conocer todos los proveedores admitidos, las variables de entorno y la configuración del proveedor de la nube.

Una vez que se inicie pi, escriba una solicitud y presione Entrar:

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

Por defecto, pi le da al modelo cuatro herramientas:

• read - leer archivos
• write - crear o sobrescribir archivos
• edit - archivos de parche
• bash - ejecutar comandos de shell

Herramientas adicionales integradas de solo lectura (grep, find, ls) están disponibles a través de las opciones de herramientas. Pi se ejecuta en su directorio de trabajo actual y puede modificar archivos allí. Utilice git u otro flujo de trabajo de puntos de control si desea una reversión sencilla.

Pi carga context files al inicio. Agregue un archivo AGENTS.md para indicarle cómo trabajar en un proyecto:

# 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 instrucciones globales
• AGENTS.md o CLAUDE.md de los directorios principales y el directorio actual

Si un directorio contiene AGENTS.override.md, Pi lo carga en lugar de AGENTS.md o CLAUDE.md de ese directorio.

Reinicie pi o ejecute /reload, después de cambiar context files.

Escriba @ en el editor para realizar una búsqueda aproximada de archivos o pase archivos en la línea de comando:

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

Se pueden pegar imágenes o texto con Ctrl+V (Alt+V en Windows); Las imágenes también se pueden arrastrar a terminales compatibles.

En modo interactivo:

!npm run lint

La salida del comando se envía al modelo. Utilice !!command para ejecutar un comando sin agregar su salida al contexto del modelo.

Utilice /model o Ctrl+L para elegir un modelo. Utilice Shift+Tab para recorrer el nivel de pensamiento. Utilice Ctrl+P / Shift+Ctrl+P para recorrer los modelos con alcance.

Las sesiones se guardan automáticamente:

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 de pi, use /resume, /new, /tree, /fork y /clone para administrar sesiones.

Para indicaciones de una sola vez:

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

Utilice --mode json para JSON salida de evento o --mode rpc para integración de procesos.

• Using Pi - modo interactivo, slash commands, sesiones, context files y CLI referencia.
• Providers - autenticación y configuración del modelo.
• Settings - configuración global y de proyecto.
• Keybindings - atajos y personalización.
• Pi Packages: instala extensiones, habilidades, indicaciones y temas compartidos.

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