Konfigurasi, kustomisasi, pengaturan platform, dan referensi API untuk Pi.

Mulai cepat

Halaman ini membawa Anda dari instalasi ke sesi pi pertama yang berguna.

Memasang

Pi didistribusikan sebagai paket npm:

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

--ignore-scripts menonaktifkan skrip siklus hidup ketergantungan selama instalasi. Pi tidak memerlukan skrip instalasi untuk instalasi npm normal.

Copot pemasangan

Gunakan manajer paket yang menginstal pi. Pemasang curl menggunakan npm secara global, sehingga pemasangan curl dan 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

Menghapus instalasi pi akan meninggalkan pengaturan, kredensial, sesi, dan paket pi yang diinstal di ~/.pi/agent/.

Kemudian mulai pi di direktori proyek yang Anda inginkan:

cd /path/to/project
pi

Otentikasi

Pi dapat menggunakan subscription providers melalui /login, atau API-penyedia kunci melalui variabel lingkungan atau file autentikasi.

Opsi 1: login berlangganan

Mulai pi dan jalankan:

/login

Kemudian pilih penyedia. Login berlangganan bawaan termasuk Claude Pro/Max, ChatGPT Plus/Pro (Codex), dan GitHub Copilot.

Opsi 2: API key

Tetapkan API key sebelum meluncurkan pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Anda juga dapat menjalankan /login dan memilih penyedia kunci API untuk menyimpan kunci di ~/.pi/agent/auth.json.

Lihat Providers untuk semua penyedia yang didukung, variabel lingkungan, dan pengaturan penyedia cloud.

Sesi pertama

Setelah pi dimulai, ketik permintaan dan tekan Enter:

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

Secara default, pi memberikan model empat alat:

  • read - membaca file
  • write - membuat atau menimpa file
  • edit - menambal file
  • bash - jalankan perintah shell

Alat baca-saja bawaan tambahan (grep, find, ls) tersedia melalui opsi alat. Pi berjalan di direktori kerja Anda saat ini dan dapat mengubah file di sana. Gunakan git atau alur kerja pos pemeriksaan lainnya jika Anda ingin pengembalian yang mudah.

Berikan instruksi proyek pi

Pi memuat context files saat startup. Tambahkan file AGENTS.md untuk memberitahukannya cara bekerja dalam 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 direktori berisi AGENTS.override.md, Pi akan memuatnya, bukan AGENTS.md atau CLAUDE.md dari direktori tersebut.

Mulai ulang pi, atau jalankan /reload, setelah mengubah context files.

Hal umum untuk dicoba

File referensi

Ketik @ di editor untuk mencari file secara fuzzy, atau teruskan file di baris perintah:

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 didukung.

Jalankan perintah shell

Dalam mode interaktif:

!npm run lint

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

Ganti model

Gunakan /model atau Ctrl+L untuk memilih model. Gunakan Shift+Tab untuk memutar tingkat pemikiran. Gunakan Ctrl+P / Shift+Ctrl+P untuk menelusuri model cakupan.

Lanjutkan nanti

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.

Mode non-interaktif

Untuk perintah sekali pakai:

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 JSON keluaran acara atau --mode rpc untuk integrasi proses.

Langkah selanjutnya

  • Using Pi - mode interaktif, slash commands, sesi, context files, dan referensi CLI.
  • Providers - otentikasi dan pengaturan model.
  • Settings - konfigurasi global dan proyek.
  • Keybindings - pintasan dan penyesuaian.
  • Pi Packages - instal ekstensi, keterampilan, petunjuk, dan tema bersama.

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