On this page
Quickstart
Quickstart
#pig runs in your terminal or web browser and works directly with files on your machine. To use it, you need access to a model through a supported provider (subscription, API key, or local model).
For native Windows setup, read Windows Setup. For Android, read Termux Setup.
---
1. System Requirements
#- PHP >= 8.3
- Standard PHP extensions:
ext-json,ext-mbstring,ext-openssl,ext-pcntl,ext-pcre(optionalext-posixfor background daemons) - Operating Systems: macOS, Linux, or Windows (WSL / Git Bash)
- Optional external tools:
fdandripgrepfor high-throughput code search (automatically detected and fetched on demand unlessPIG_OFFLINEis set) - Composer, which the installer uses
---
2. Install pig
#Quick Install (macOS / Linux)
#Run the official installer script:
curl -fsSL https://pigagent.dev/install.sh | sh
Or Install via Composer
#composer global require pigagent/pig
Ensure Composer's global bin folder is on your $PATH:
export PATH="$PATH:$HOME/.composer/vendor/bin"
Verify your installation:
pig --version
# Output: pig <version>
Keep pig up-to-date anytime by running:
pig update
---
3. Start pig
#Change to your project folder, then start pig:
cd /path/to/folder
pig
The working folder helps pig discover context files (CLAUDE.md / AGENTS.md), project Skills, custom tools, and git state.
---
4. Choose a Model & Provider
#In pig, run:
/login
Choose your provider:
- Anthropic (Claude Pro/Max), GitHub Copilot: sign in with your subscription through the browser or device flow.
- Anthropic / OpenAI / Groq and others: Provide your API key, or export it in your shell environment (e.g.
export ANTHROPIC_API_KEY="sk-..."). - Antigravity: available once the
pig-antigravityextension is installed (pig update --extensions) and its OAuth client is configured; see Provider Authentication.
Switch active models anytime with /model.
---
5. Web UI Mode
#If you prefer a browser chat interface with concurrent multi-session tabs:
# Start as a persistent background daemon
pig web start -d
# Open in your browser
open http://127.0.0.1:8088
Or type /web inside any active terminal session to launch a temporary browser UI.
---
6. Run Tasks
#pig streams actions, file reads, diff edits, searches, and bash executions in real-time:
Summarize @notes.txt and save the action items to action-items.md.
Explain how this project is structured and run its unit tests.
---
Common Commands & Shortcuts
#Esc: Abort current running turn or tool call.Ctrl+O: Fold or expand tool executions and verbose diffs.Ctrl+T: Toggle thinking blocks visibility./compact: Compact session context into a summary./tree: Browse and restore conversation branch tree./web: Launch the multi-session Web UI./doctor: Inspect the PHP runtime, external binaries, and auth tokens./help: Show full command and hotkey list./quitor/exit: Exit pig cleanly.