mirror of
https://github.com/badlogic/pi-mono.git
synced 2026-11-05 23:37:25 +00:00
25cc5c7bf4
* docs(coding-agent): improve getting started documentation * docs(coding-agent): correct getting started details * docs(coding-agent): clarify SDK entry point * docs(coding-agent): restructure guides and references * docs(coding-agent): improve getting started guides * docs(coding-agent): refresh integration guides * docs(coding-agent): improve terminal and CLI guides * docs(coding-agent): refresh customisation guides * docs(coding-agent): clarify project trust terminology * docs(coding-agent): simplify customisation guidance * docs(coding-agent): improve runtime and reference guidance * Fix settings reference * feat(coding-agent): add Crowdin documentation sync * docs(coding-agent): separate CLI and slash command references * docs(coding-agent): correct compaction reference * docs(coding-agent): streamline package documentation * docs(coding-agent): split RPC reference documentation * Update configuration docs * Shorten config docs * docs(coding-agent): refine configuration references * docs(coding-agent): streamline settings reference * docs(coding-agent): clarify configuration reference * docs(coding-agent): clarify project trust exception * docs(coding-agent): simplify keybindings reference * docs(coding-agent): remove Crowdin integration * docs(coding-agent): turn themes reference into guide * docs(coding-agent): consolidate model and authentication docs * docs(tui): require Component.invalidate() (fixes #9358) * docs(coding-agent): document offline catalog behavior (fixes #8684) * docs(coding-agent): preserve established documentation routes * docs(coding-agent): reorganize documentation navigation * docs(coding-agent): correct audited behavior Clarify provider, session, local-model, Termux, TUI, SDK, debug, and extension behavior. Simplify the documentation audit to report only clear user-visible contradictions. * docs(coding-agent): fix broken documentation links
39 lines
2.5 KiB
Markdown
39 lines
2.5 KiB
Markdown
# Pi
|
|
|
|
Pi 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 Pi for software development, research notes, writing projects, data files, or hobby work. You can use Pi as is, prompt it to adapt itself to your workflow, or build other applications powered by Pi using the SDK.
|
|
|
|
## Start using Pi
|
|
|
|
New to Pi? Follow the [Quickstart](quickstart.md) to install Pi, connect a model, and complete your first task.
|
|
|
|
If Pi is already installed, choose what you want to do:
|
|
|
|
- [Use Pi interactively](usage.md) to add files, run commands, direct ongoing work, and export results.
|
|
- [Choose a model](models.md) or connect a subscription, API key, local model, or compatible endpoint.
|
|
- [Continue or branch a session](sessions.md) to resume work or explore another approach without losing history.
|
|
- [Configure Pi](configuration.md) for your preferences, working folders, instructions, and reusable resources.
|
|
- [Understand how Pi works](how-pi-works.md), including tools, context, sessions, and the agent loop.
|
|
|
|
## Customize Pi
|
|
|
|
Pi can reuse prompts, load specialized instructions, add executable integrations, change its terminal interface, connect model services, and distribute these resources as packages.
|
|
Use the [Quickstart customization chooser](quickstart.md#choose-how-to-customize-pi) to select the smallest mechanism that meets your need.
|
|
|
|
## Automate or embed Pi
|
|
|
|
- Use [print mode](cli.md#invocation-and-output) for one-off and scripted tasks.
|
|
- Use [JSON event stream mode](json.md) to consume structured events from one run.
|
|
- Use [RPC mode](rpc.md) to control a separate Pi process.
|
|
- Use the [TypeScript SDK](sdk.md) to run Pi inside an application.
|
|
|
|
## Find reference and setup information
|
|
|
|
Use the reference pages to look up [CLI options](cli.md), [settings](settings.md), [provider authentication](providers.md), [keybindings](keybindings.md), and [environment variables](environment-variables.md).
|
|
|
|
For platform-specific help, see [Terminal Setup](terminal-setup.md), [Windows](windows.md), [tmux](tmux.md), [Termux on Android](termux.md), or [Containerization](containerization.md).
|
|
|
|
## Work safely
|
|
|
|
Pi's tools and extensions run with the permissions of the Pi process. Project trust controls which project resources Pi loads, but it does not sandbox tool calls. Review [Security](security.md) before using untrusted files, repositories, extensions, or unattended automation.
|