Skip to main content

A zero-dependency Python CLI toolset designed for AI agents to analyze codebases with surgical precision.

Project description

pypeeker-cli: Unified Agent-Native Python Analysis CLI

PyPI Powered by Cartograph License CI

pypeeker-cli is a mcp-dependency only Python CLI toolset designed for AI agents to analyze codebases with surgical precision. It transforms raw source code into structured, actionable logical maps.


Cartograph Showcase

pypeeker-cli is a premier showcase for Cartograph, a platform for reusable engineering.

Every core feature in pypeeker-cli, from AST parsing to graph cycle detection, is implemented as a standalone, validated Cartograph widget. This architecture ensures that pypeeker-cli is not just a tool, but a modular assembly of hardened building blocks that can be easily extended or repurposed.


Analysis Surface Area

pypeeker-cli categorizes its tools by Analysis Surface Area, allowing agents to choose the right depth for their task:

1. Project Scan (Horizontal)

Broad audits of the entire project tree to find relationships and hazards.

  • circular: Find import dependency loops (identifies runtime crashes vs safe TYPE_CHECKING cycles).
  • missing: Detect hallucinated or missing internal imports using Dynamic Root Discovery.
  • interfaces: Validate code contracts (flags missing docstrings and type hints; tests are ignored by default, use --include-tests to opt in).

2. Navigation (Relationship)

Pinpoint and trace symbols across file boundaries.

  • locate: Find a symbol's exact definition bounds (start/end lines) or trace its usages (--usages) and ancestry (--inherited).

3. Deep Dive (Vertical)

Surgical analysis inside a specific file or function.

  • skeleton: Extract the API surface of a file (imports, classes, variables, signatures) without function bodies.
  • impact: Analyze the blast radius of a function, distinguishing between internal and external side effects.

Tool Showcase

Two views the Read tool can't give an agent in one call:

  • skeleton — the API surface, without function bodies. Map a file or a whole package, get every signature with line ranges, jump straight to the methods that matter.
  • impact — the side-effect map of a function, without mentally tracing the body. What it calls, what it reads, what it writes, whether it touches globals — answered structurally.

The walkthrough below uses psf/requests — a real, well-known library — to answer a real agent question: "How does requests handle authentication during redirects?"

Map the file — skeleton

Strip every function body. Keep imports, signatures, docstrings, and the line range each symbol occupies.

$ pypeeker skeleton requests/sessions.py --format stub
import os
import time
from .auth import _basic_auth_str
from .cookies import RequestsCookieJar, extract_cookies_to_jar
# ...

class SessionRedirectMixin:  # L107-353
    def get_redirect_target(self, resp):  # L108-126
        """Receives a Response. Returns a redirect URI or ``None``"""
        ...

    def should_strip_auth(self, old_url, new_url):  # L128-158
        """Decide whether Authorization header should be removed when redirecting"""
        ...

    def rebuild_auth(self, prepared_request, response):  # L282-300
        """When being redirected we may want to strip authentication..."""
        ...

The two methods we want — should_strip_auth and rebuild_auth — are now visible with their exact line ranges.

Trace what a function touches — impact

Once you've found the function, the next agent question is usually "what does this affect?" — globals, class state, external calls. Reading the body to find out is the manual approach. impact answers structurally:

$ pypeeker impact SessionRedirectMixin.rebuild_auth requests/sessions.py
{
  "external": {
    "calls":  ["get_netrc_auth", "prepared_request.prepare_auth", "self.should_strip_auth"],
    "reads":  ["self.trust_env", "..."],
    "writes": [],
    "globals": []
  },
  "internal": {
    "writes": ["headers", "new_auth", "url"]
  }
}

Three external dependencies. Zero global writes. Zero shared-state mutation. That's a refactor-safety check the agent can do before changing anything, in one call instead of a multi-pass read.

impact accepts both bare names (rebuild_auth) and qualified names (SessionRedirectMixin.rebuild_auth) for unambiguous targeting when multiple classes share method names.

The token math

Same task — find where requests handles redirect auth — measured against actual agent tool output, including the Read tool's line-number prefixes. Tokens counted with OpenAI's o200k_base tokenizer (used by GPT-4o, o1, o3, and GPT-5).

Workflow Tokens
Read sessions.py (full file) 9,063
skeleton sessions.py + 2 targeted Read calls (L128-158, L282-300) 3,218

The agent ends up reading only the two methods that actually matter, instead of 833 lines hoping the relevant code is in there — and the skeleton's line ranges (# L128-158) made the targeting possible.

For project-scale orientation, mapping the full requests package (18 files):

Operation Tokens
Read every .py file in requests/ 59,901
skeleton requests/ 19,508

The entire library API surface — every public class, signature, docstring, and line range — in one call.

Also included

  • locate — AST-aware symbol search with scope ranges (path:start-end signature). No false positives from substring matches; distinguishes definitions from usages.
  • circular — find import cycles, separates runtime cycles from safe TYPE_CHECKING cycles.
  • missing — detect hallucinated or broken internal imports.
  • interfaces — flag missing docstrings and type annotations across a project.

All tools default to condensed text/stub output over MCP. Pass --format json on the CLI for structured output suitable for jq and downstream tooling.


Installation

Install the pypeeker-cli core primitive globally using pip:

pip install pypeeker-cli

This provides the pypeeker command on your system path.


Agent Native Integration

pypeeker-cli is designed to be consumed by AI agents via the Model Context Protocol (MCP). After installing the CLI, you can integrate it into your agent of choice.

Integration Methods

Gemini CLI

Install as a native extension:

gemini extensions install https://github.com/benteigland11/pypeeker

Claude Code

Add as a persistent MCP server:

claude mcp add pypeeker-cli -- pypeeker mcp

Codex

Add as a global MCP server:

codex mcp add pypeeker-cli -- pypeeker mcp

Cursor and Roo Code

Pypeeker is pre-configured for automatic detection via .cursor/mcp.json.

Continue

The server is pre-configured via .continue/mcpServers/pypeeker.json.

Windsurf

The server is pre-configured via .windsurf/mcp_config.json.

Claude Desktop and Aider

Copy the JSON from claude_desktop_snippet.json into your global claude_desktop_config.json.


Reusable Core

Built using the following Cartograph Widgets (found in cg/):

  • cg-infra-agent-cli-python: Machine-first declarative CLI framework.
  • data-ast-import-parser-python: Root-aware static import analysis.
  • data-ast-skeleton-parser-python: API signature extraction.
  • data-ast-symbol-locator-python: Surgical symbol pinpointing and ancestry.
  • data-ast-interface-validator-python: API gap detection.
  • data-ast-impact-analyzer-python: Side-effect and dependency mapping.
  • infra-mcp-manifest-generator-python: Automated distribution scaffolding.
  • universal-agent-response-python: Standardized JSON schema.
  • universal-list-paginator-python: Result set pagination.

License

Licensed under the Apache License, Version 2.0. See the LICENSE file for details.

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

pypeeker_cli-1.3.0.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

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

pypeeker_cli-1.3.0-py3-none-any.whl (67.9 kB view details)

Uploaded Python 3

File details

Details for the file pypeeker_cli-1.3.0.tar.gz.

File metadata

  • Download URL: pypeeker_cli-1.3.0.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pypeeker_cli-1.3.0.tar.gz
Algorithm Hash digest
SHA256 4fb5577174b4bd6a2942489db5fab3ac5b4f381c8ae7996e0415bd32d17949e6
MD5 690f772b976016a996d7d5318eb69d01
BLAKE2b-256 6e378f3e9bdc636d0b4b5df0215ed3ee17f6dfa7ef1d7df6348d0651c514ebeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypeeker_cli-1.3.0.tar.gz:

Publisher: pypi-publish.yml on benteigland11/pypeeker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypeeker_cli-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: pypeeker_cli-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 67.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pypeeker_cli-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 234af87b38e276280f2999f2fc8ecc179b3bbe2216ea57ab04af448ae296f1ff
MD5 7677b8a897a724f1e5963b0ca6a5d7d5
BLAKE2b-256 7ae5e08e91eafdc6022a8fba6486f8d2eca67f634ba822efde4a71b5e1d50df8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypeeker_cli-1.3.0-py3-none-any.whl:

Publisher: pypi-publish.yml on benteigland11/pypeeker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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