Mulai cepat

Halaman ini memandu Anda dari instalasi hingga sesi pi pertama yang berguna.

Pi didistribusikan sebagai paket npm:

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

--ignore-scripts menonaktifkan skrip lifecycle dependensi selama instalasi. Pi tidak memerlukan skrip instalasi untuk instalasi npm normal.

Gunakan package manager yang dulu menginstal pi. Installer curl menggunakan npm secara global, jadi instalasi melalui curl maupun npm dihapus dengan 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

Mencopot pi tetap menyimpan pengaturan, kredensial, sesi, dan paket pi yang sudah terinstal di ~/.pi/agent/.

Lalu jalankan pi di direktori proyek yang ingin Anda kerjakan:

cd /path/to/project
pi

Pi dapat menggunakan provider subscription melalui /login, atau provider berbasis API key melalui variabel lingkungan maupun file autentikasi.

Jalankan pi, lalu jalankan:

/login

Kemudian pilih provider. Login subscription bawaan mencakup Claude Pro/Max, ChatGPT Plus/Pro (Codex), dan GitHub Copilot.

Atur API key sebelum menjalankan pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Anda juga dapat menjalankan /login dan memilih provider berbasis API key untuk menyimpan key di ~/.pi/agent/auth.json.

Lihat Providers untuk daftar semua provider yang didukung, variabel lingkungan, dan konfigurasi cloud provider.

Setelah pi berjalan, ketik permintaan lalu tekan Enter:

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

Secara default, pi memberikan empat tool kepada model:

• read - membaca file
• write - membuat atau menimpa file
• edit - mengubah file dengan patch
• bash - menjalankan perintah Shell

Tool bawaan read-only tambahan (grep, find, ls) tersedia melalui opsi tool. Pi berjalan di direktori kerja saat ini dan dapat mengubah file di sana. Gunakan Git atau workflow checkpoint lain jika Anda ingin mudah melakukan rollback.

Pi memuat context files saat startup. Tambahkan file AGENTS.md untuk memberi tahu Pi cara bekerja di sebuah proyek:

# Project Instructions

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

Pi memuat:

• ~/.pi/agent/AGENTS.md untuk instruksi global
• AGENTS.md atau CLAUDE.md dari direktori induk dan direktori saat ini

Jika sebuah direktori berisi AGENTS.override.md, Pi memuat file itu alih-alih AGENTS.md atau CLAUDE.md dari direktori tersebut.

Restart pi, atau jalankan /reload, setelah mengubah context files.

Ketik @ di editor untuk mencari file secara fuzzy, atau teruskan file lewat command line:

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

Gambar atau teks dapat ditempel dengan Ctrl+V (Alt+V di Windows); gambar juga dapat diseret ke terminal yang mendukungnya.

Dalam mode interaktif:

!npm run lint

Output perintah dikirim ke model. Gunakan !!command untuk menjalankan perintah tanpa menambahkan outputnya ke konteks model.

Gunakan /model atau Ctrl+L untuk memilih model. Gunakan Shift+Tab untuk mengganti thinking level. Gunakan Ctrl+P / Shift+Ctrl+P untuk berpindah di antara scoped models.

Sesi disimpan secara otomatis:

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

Di dalam pi, gunakan /resume, /new, /tree, /fork, dan /clone untuk mengelola sesi.

Untuk prompt sekali jalan:

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

Gunakan --mode json untuk output event JSON, atau --mode rpc untuk integrasi proses.

• Using Pi - mode interaktif, slash commands, sesi, context files, dan referensi CLI.
• Providers - autentikasi dan pengaturan model.
• Settings - konfigurasi global dan proyek.
• Keybindings - shortcut dan kustomisasi.
• Pi Packages - instal extension, Skills, Prompts, dan Themes bersama.

Catatan platform: Windows, Termux, tmux, Terminal setup, Shell aliases.