On this page
pig
pig
#pig is an extensible AI agent that works from your terminal. Give it a goal and a working folder, and it can inspect files, run commands, edit content, and work through multi-step tasks.
Use pig for software development, research notes, writing projects, data files, or hobby work. You can use pig as is, prompt it to adapt itself to your workflow, or build other applications powered by pig using the SDK.
Start using pig
#New to pig? Follow the Quickstart to install pig, connect a model, and complete your first task.
If pig is already installed, choose what you want to do:
- Use pig interactively to add files, run commands, direct ongoing work, and export results.
- Choose a model or connect a subscription, API key, local model, or compatible endpoint.
- Continue or branch a session to resume work or explore another approach without losing history.
- Configure pig for your preferences, working folders, instructions, and reusable resources.
- Understand how pig works, including tools, context, sessions, and the agent loop.
Customize pig
#pig can reuse prompts, load specialized instructions, add executable integrations, change its terminal interface, connect model services, and distribute these resources as packages.
Choose the smallest mechanism that meets your need: prompt templates for reusable prompts, skills for on-demand instructions, extensions for executable integrations, themes for colors, custom providers for model services, and pig packages to distribute them.
Automate or embed pig
#- Use print mode for one-off and scripted tasks.
- Use JSON event stream mode to consume structured events from one run.
- Use RPC mode to control a separate pig process.
- Use the PHP SDK to run pig inside an application.
Find reference and setup information
#Use the reference pages to look up CLI options, settings, provider authentication, keybindings, and environment variables.
For platform-specific help, see Terminal Setup, Windows, tmux, Termux on Android, or Containerization.
Work safely
#pig's tools and extensions run with the permissions of the pig process. Project trust controls which project resources pig loads, but it does not sandbox tool calls. Review Security before using untrusted files, repositories, extensions, or unattended automation.