Skip to main content

Potpie context engine

Reason this release was yanked:

GitHub integration not working

Project description

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 configured integration auth status.
potpie status --verify Verify integration credentials with lightweight API checks.
potpie status --host Check daemon, pot, graph, and skill readiness.
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 status --host
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 context-engine 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

  • GitHub Issues: bugs and repository-scoped requests
  • Discord: community discussion and support
  • Docs: setup, product guides, and integration details

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

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

potpie-2.0.0b2.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

potpie-2.0.0b2-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file potpie-2.0.0b2.tar.gz.

File metadata

  • Download URL: potpie-2.0.0b2.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for potpie-2.0.0b2.tar.gz
Algorithm Hash digest
SHA256 093b5bc0e878c9322efe752786c62b21a3b06e2f748b1341aa4a334389cbe4a4
MD5 f31218cc6a185b9ce3f149188763b0ca
BLAKE2b-256 be2aa4b49efeec23954e03ff538fd65317c36457e074bebf163fbee3ba45dd6c

See more details on using hashes here.

File details

Details for the file potpie-2.0.0b2-py3-none-any.whl.

File metadata

  • Download URL: potpie-2.0.0b2-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for potpie-2.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 54b4152a121494808d58832019adb8808cbbbe3bf0ec025b8eab59b776ae01e6
MD5 03ef7dd5334b306160db20385a2a0e94
BLAKE2b-256 f68b735cbf02f3a48fa86ef8359315a5904eeb636a8634e7ddb6d91856fc8efb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page