e509d7edc7
The Quickstart only showed the macOS/Linux `curl` installer, even though `install.ps1` installs Pi the same way: a managed install pinned by the published lockfile, updated with `pi update`. This PR adds the Windows installer as a second tab next to the existing one. All other sections stay the same. ````markdown Install Pi with the installer on macOS, Linux, or Windows: ```bash tab="macOS / Linux" curl -fsSL https://pi.dev/install.sh | sh ``` ```powershell tab="Windows" powershell -c "irm https://pi.dev/install.ps1 | iex" ``` Both installers pin all dependencies and update Pi with `pi update`. ... ```` The tabs are labelled by platform rather than by shell: newcomers know their OS, and the command also works when pasted into cmd. Tab rendering on pi.dev comes from earendil-works/pi.dev#183. This PR can merge before or after it. Until the renderer ships, and on GitHub, the page shows two ordinary code blocks, and the prose still reads correctly. ## Screenshots (with earendil-works/pi.dev#183) | | Default | Windows tab selected | |---|---|---| | Dark |  |  | | Light |  |  |
4.7 KiB
Quickstart
Pi runs in your terminal and works with files on your machine. To use it, you need access to a model through a supported provider. This can be a subscription, an API key, or a local model.
For native Windows setup, read Windows Setup. For Android, read Termux Setup.
1. Install Pi
Install Pi with the installer on macOS, Linux, or Windows:
curl -fsSL https://pi.dev/install.sh | sh
powershell -c "irm https://pi.dev/install.ps1 | iex"
Both installers pin all dependencies and update Pi with pi update. Alternatively, install Pi from npm, which does not pin transitive dependencies. This requires Node.js 22.19 or newer:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent
Pi does not require dependency lifecycle scripts for a normal npm installation.
With Nix on macOS or Linux, install the latest release from Pi's flake. Nix builds Pi from source:
nix profile add github:earendil-works/pi/stable
Older Nix versions use nix profile install instead. Update with nix profile upgrade pi; pi update cannot update a Nix installation. To pin a release, use a tag such as github:earendil-works/pi/v1.0.0.
Verify the installation:
pi --version
2. Start Pi
Change to the folder you want Pi to work with, then start it:
cd /path/to/folder
pi
The working folder helps Pi discover relevant files, instructions, and configuration. Pi also uses it to group saved sessions.
The interface shows your conversation, an editor for prompts and commands, and a footer with the current folder, model, and session status. See Use Pi in the terminal to learn how to add files, run commands, direct ongoing work, and manage results.
3. Choose a model
A model generates Pi's responses. A provider is the service or account Pi uses to access that model.
In Pi, run:
/login
Choose a provider, then follow the prompts to use a subscription or store an API key. Run /model afterward if you want to select a different available model.
See Choose a model and provider for supported providers, environment-variable authentication, local models, and custom endpoints.
4. Give Pi a task
Pi shows each file read, search, command, and edit it performs. It does not ask before every tool call.
Enter a task that matches your work, for example:
Summarize @meeting-notes.md and save the action items to action-items.md.
Explain how this repository is structured and how to run its checks.
Compare @previous.csv with @current.csv and summarize the important changes.
Type @ in the editor to search for a file instead of entering its full path. When Pi finishes, review its response and any changed files. Use version control or backups for important work. For untrusted or unattended work, use a container or another sandbox. See Security.
Continue later
Pi saves sessions automatically. Exit Pi, then resume the most recent session for the same working folder with:
pi --continue
Use /resume to choose another saved session. See Continue or branch a session for session naming, branching, compaction, export, and sharing.
Next steps
- Use Pi interactively to learn input, commands, shortcuts, and queued messages.
- Add instructions that Pi should follow whenever it works in a folder.
- Choose a model and provider.
Choose how to customize Pi
Start with the least powerful mechanism that meets your need:
| Need | Start with |
|---|---|
| Give Pi persistent instructions for a folder | AGENTS.md |
Reuse a prompt from the / menu |
Prompt template |
| Add task-specific instructions and supporting files | Skill |
| Add executable tools, commands, or event handlers | Extension |
| Build a custom terminal component | Terminal UI |
| Connect an unsupported model service | Custom provider |
| Install or distribute several resources | Pi package |
Uninstall Pi
If you installed Pi with npm, run:
npm uninstall -g @earendil-works/pi-coding-agent
If you used the installer, run it again and choose Uninstall Pi:
curl -fsSL https://pi.dev/install.sh | sh
If you installed Pi with Nix, run:
nix profile remove pi
None of these methods removes configuration, credentials, sessions, or installed Pi packages from ~/.pi/agent/.