potpie README

The project's README from github.com/potpie-ai/potpie. As one markdown file: README.md.

Potpie AI logo

Docs Tests PyPI Discord Apache 2.0

Potpie turns your codebase and software development lifecycle into a living context graph for AI agents. It indexes code, structure, decisions, source history, team knowledge and engineering workflows, so agents can answer questions, plan changes, debug failures, and write code with project-specific context.

Potpie context graph demo

Install and setup Potpie

Step 1: install the CLI through PyPI with uv or pip:

uv tool install potpie

or:

python3 -m pip install --user potpie

[!NOTE] uv tool install potpie is recommended for CLI installs because global mutation of Python packages is generally not recommended.

Step 2: Run the Potpie setup wizard

potpie setup

The setup wizard provisions local config, storage, the daemon, a default pot, and agent skills. It also lets you choose integrations and the coding harness Potpie should configure.

Potpie setup wizard

Step 3: Open your configured harness

Potpie is already integrated into your selected harness. You can start using Potpie with the repo of your choice.

Open your previously selected harness and ask it to use Potpie for the repo. Potpie in OpenAI Codex

[!NOTE] You don't need to run a separate manual ingest command. The CLI registers sources and the configured agent can ingest or update project context when the task requires it.

You can view your context graph in the web UI:

potpie ui

This will open a graph explorer in your browser. Potpie web UI

Basic CLI user checklist

The main CLI commands are:

Command Purpose
potpie setup Run first-time local setup for config, daemon, default pot, and agent skills.
potpie login Sign in to Potpie for account-backed and managed features.
potpie github login / potpie linear login Connect source integrations you want agents to use.
potpie status Show context readiness for the active pot, including daemon, graph, and skill checks.
potpie auth status Show configured integration auth status.
potpie auth status --verify Verify integration credentials with lightweight API checks.
potpie doctor Run local diagnostics for daemon, backend capabilities, and skill drift.
potpie source add repo . Register the current repo as a source for the resolved pot.
potpie pot list / potpie pot use <id-or-name> List pots and choose the active workspace.
potpie resolve "<task>" Pull the context an agent should read before doing a task.
potpie search "<query>" Look up a specific file, workflow, bug, decision, or convention.
potpie record --type <type> --summary "<summary>" Write a durable project learning.
potpie graph ... Use lower-level graph reads, quality checks, proposals, and commits.
potpie ui Open the local graph explorer served by the daemon.
potpie skills install --agent <agent> Install or refresh Potpie guidance for an agent harness.

Examples:

potpie setup --repo . --agent claude
potpie github login
potpie auth status
potpie status
potpie source add repo .
potpie resolve "what should I know before working in this repository?"
potpie search "authentication flow"
potpie record --type decision --summary "Prefer the Potpie CLI for graph work"

You can find an exhaustive list with more examples in our docs.

Integrations and Coding Harnesses

Potpie supports a variety of integrations and coding harnesses, with more coming. If your team needs a new integration or harness, please raise a ticket.

Integrations

Tool Description
GitHub Index repositories, pull requests, issues, reviews and source history.
Linear Index teams, issues, projects and documents.
Jira Index projects, issues, status and changelog context.
Confluence Index spaces, pages, runbooks and decisions.

Coding harnesses

Tool Description
Claude Code Install Potpie instructions and skills for Claude Code.
OpenAI Codex Install Potpie instructions and skills for OpenAI Codex.
Cursor Install Potpie instructions and skills for Cursor.
OpenCode Install Potpie skills for OpenCode.

Architecture

Potpie's current architecture is CLI-first. CLI is designed to be used by both humans and agents. Read the deeper architecture notes in docs/context-graph/architecture.md.

License

This project is licensed under the Apache 2.0 License. See LICENSE.

Community & Support

New contributions are always welcome. Read the Contributing Guide to set up your environment, understand the workflow, and open a pull request.

Contributors

potpie (potpie-ai/potpie)

Searching Database…

5.7K ·GitHub
Potpie
What is this?Potpie turns your codebase and software development lifecycle into a living context graph for AI agents. It indexes code, structure, decisions, source history, team knowledge and engineering workflows so agents can answer questions, plan changes, debug failures, and write code with project-specific context.
Is this a CLI tool or a framework I import into my code?It is CLI-first: you install the 'potpie' command, run a local daemon, and get a local web graph explorer; you do not import it as a library, you point your coding agent (harness) at the CLI-managed context graph.
How do I get it running?Install the CLI with 'uv tool install potpie' (recommended) or pip, run 'potpie setup' to provision local config, storage, the daemon, a default pot, and agent skills, then open your configured harness and ask it to use Potpie for the repo.
Do I need accounts or logins for GitHub, Linear, or Jira integrations?Account-backed and managed features require 'potpie login', and each source integration needs its own login, like 'potpie github login' or 'potpie linear login'; you can verify credentials with 'potpie auth status --verify'.
What if my coding agent isn't Claude Code, Codex, Cursor, or OpenCode?Only those four coding harnesses are supported today; if your team needs a different harness or integration, you have to raise a ticket and wait for support to be added.
What is a 'pot' in Potpie?A pot is the active workspace Potpie tracks context for — you register repos as sources to a pot and switch between pots with 'potpie pot list' and 'potpie pot use'.
How is this different from plain RAG over my codebase?Instead of just embedding and retrieving text chunks, Potpie builds a structured graph linking code, decisions, source history, and workflows from tools like GitHub, Linear, Jira, and Confluence.
Can I see the context graph visually?Yes, running 'potpie ui' opens a local graph explorer in your browser, served by the local daemon.
Can an agent write new knowledge back into the graph?Yes, the 'potpie record --type --summary' command lets an agent or user save a durable project learning into the context graph.
What are similar projects?openrig, Agentlas-OS, headroom, graphify, brag, omnigent, coral, copperhead
Which topics is it in?devtools, knowledge-graph, agent-framework, artificial-intelligence, cursor, rag, generative-ai, agents, codex, agent, claude-code, mcp
Creator
potpie-ai
Size
58.3 MB
Stars
5.7K
Updated
CommitOct 16Releasev2.0.1Aug 31
Age
2y
Commits · 90 Days