Skip to main content

Symbol index with associated code reading tools for AI coding agent navigation

Project description

uncoded

AI coding agents navigate codebases poorly. They grep for guessed keywords, skim the first few lines of files, and fill gaps from pretraining rather than reading the actual code. The result is plausible-looking output built on a hallucinated understanding of code that's sitting right there, unread.

uncoded builds a static navigation index so agents can orient themselves at the start of a task and navigate deterministically to what they need — no guessing, no grep.

It also ships uncoded body to read symbol bodies and uncoded refs for finding every reference to a symbol — callers, dead-symbol checks, pre-rename footprint.

What it generates

Running uncoded sync produces:

.uncoded/namespace.yaml — a hierarchical YAML file listing every symbol: directories, files, classes (with attributes and methods), functions. Covers all configured source roots. An agent can load this at the start of a task and immediately know the full vocabulary of the codebase.

.uncoded/stubs/ — one .pyi stub per source file, with imports, full signatures (parameter names, types, return types), module constants, and class attributes.

.claude/skills/coherence-review/SKILL.md and .agents/skills/coherence-review/SKILL.md — a coherence review skill, written to both Claude Code and Codex skill directories (see Coherence review below).

uncoded also injects a navigation protocol into CLAUDE.md/AGENTS.md, so agents working in the repo pick up the instructions automatically.

Install uv

uncoded runs via uv. Install uv if you don't already have it; no separate uncoded install is needed — uvx runs it from PyPI on demand.

Configure

Add a [tool.uncoded] section to your pyproject.toml:

[tool.uncoded]
source-roots = ["src", "tests"]

Use

uvx uncoded sync

Run it from the repo root. It reads pyproject.toml to find your source roots, builds the index, and updates CLAUDE.md/AGENTS.md.

Commit the generated .uncoded/ directory so agents working in the repo always have a current index.

Keep it current with pre-commit

Add uncoded sync as a pre-commit hook so the index stays in sync automatically:

- repo: local
  hooks:
    - id: uncoded
      name: uncoded
      entry: uvx uncoded sync
      language: system
      pass_filenames: false

Like ruff format: if uncoded sync modifies any files, the commit fails and you stage the updated index before committing again.

You can also set up your CI to run pre-commit run --all-files to verify the index is up to date.

Verify the index is fresh

For CI or scripted checks that must not modify the working tree, use the check subcommand:

uvx uncoded check

It runs the same pipeline but writes nothing. Exits 0 if every generated file is byte-identical to what a rebuild would produce, and 1 otherwise — printing which files would change. A stale index is a silent failure mode (agents read misleading names and signatures), so gating on this in CI is worthwhile even alongside a pre-commit hook.

Retrieve a symbol body

Use the body subcommand when you need a symbol's implementation, not just its signature from the stub:

uvx uncoded body <name_path> --in <relative_path>

name_path is a slash-separated path: one segment (fn) for a top-level symbol, two for a class member (Class/method). --in is the source file's path (relative to cwd). The command prints the source text of the symbol to stdout, byte-identical to what's on disk — no reformatting, no ast.unparse normalisation.

For example, to retrieve the body of resolve_body from src/uncoded/body.py:

uvx uncoded body resolve_body --in src/uncoded/body.py

Find references to a symbol

Use the refs subcommand for impact analysis: run it before a rename, signature change, or delete, or to confirm a symbol is dead before removing it:

uvx uncoded refs <name_path> --in <relative_path>

name_path follows the same convention as body: one segment for a top-level symbol, two for a class member (Class/method). Output is one reference per line as <rel_path>:<line>:<col>, with line and column 1-indexed and results sorted by path, then line, then column. Exits 0 on success; empty output means no references.

For example, to find all callers of resolve_body:

uvx uncoded refs resolve_body --in src/uncoded/body.py

How agents use it

When uncoded is set up, a navigation section is automatically maintained in the configured instruction files (by default, CLAUDE.md and AGENTS.md). Agents following that protocol:

  1. Read .uncoded/namespace.yaml to orient — every symbol, at a glance.
  2. Read the relevant .pyi stubs to understand imports, signatures, constants, and class members.
  3. Run uvx uncoded body <name_path> --in <relative_path> when they need implementation detail for a specific symbol.
  4. Run uvx uncoded refs <name_path> --in <relative_path> to find every reference to a symbol — callers, dead-symbol checks. See Find references to a symbol for detail.
  5. Edit a symbol using Edit with uncoded body's output as old_string.
  6. Rename across the codebase using uncoded refs to enumerate every site, then Edit at each.
  7. Safely delete by running uncoded refs first — the output must be empty — then Edit to remove.

The split is deliberate: uncoded provides a stable map and signature index; uncoded body resolves a symbol's source body; uncoded refs maps every reference. No grep, no stale line-number coordinates, no offset arithmetic.

Coherence review

AI coding agents tend to leave codebases in an incoherent state: names that no longer match behaviour, docstrings that describe stale signatures, dead symbols, pattern changes applied in some places but not others. uncoded sync installs a /coherence-review skill that runs a structured diagnostic sweep to find these problems.

Invoke it in Claude Code:

/coherence-review

The review works in four sweeps:

  1. Orient — loads namespace.yaml and forms a vocabulary map.
  2. Lexical — scans the namespace for naming inconsistency: concept duplication, qualifier accretion (_v2, _legacy, _final), vocabulary islands, name collision with drift.
  3. Promissory — checks each public symbol's name / signature / docstring triple for internal disagreement. Names and signatures come from the stub; docstrings come from uncoded body.
  4. Structural — checks for boundary violations (private symbols imported across modules), overgrown public surfaces, cross-domain imports, and zero-caller public symbols.

Output is a timestamped Markdown report saved to .uncoded/reviews/, with verbatim evidence and a confidence level (high / medium / low) for each finding. The review only reports — it proposes no fixes. The human decides what to follow up.

Dev setup

Clone, install dependencies, and wire up the pre-commit hooks:

git clone https://github.com/alimanfoo/uncoded
cd uncoded
uv sync --extra dev
uv run pre-commit install

Run the tests (branch coverage is enforced; see [tool.coverage.report] in pyproject.toml for the threshold):

uv run pytest

To run a subset of tests without the coverage gate:

uv run pytest tests/test_stubs.py --no-cov

Run the same checks CI's lint job runs:

uv run pre-commit run --all-files

Note for Windows contributors

CLAUDE.md is a symlink to AGENTS.md (single source). macOS and Linux handle this transparently; on Windows, git's core.symlinks setting must be enabled, or the checkout writes CLAUDE.md as a plain file containing the literal string AGENTS.md and the navigation section drifts.

Releasing

GitHub releases publish to PyPI through .github/workflows/publish.yml. The workflow uses PyPI Trusted Publishing, so it does not need a PYPI_TOKEN or any other long-lived publishing secret.

The PyPI trusted publisher is configured for:

  • PyPI project: uncoded
  • Owner: alimanfoo
  • Repository: uncoded
  • Workflow: publish.yml
  • Environment: pypi

To release, create and publish a GitHub release from the release tag. The published release event builds the source distribution and wheel, then uploads them to PyPI.

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

uncoded-1.0.0.tar.gz (84.1 kB view details)

Uploaded Source

Built Distribution

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

uncoded-1.0.0-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

Details for the file uncoded-1.0.0.tar.gz.

File metadata

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

File hashes

Hashes for uncoded-1.0.0.tar.gz
Algorithm Hash digest
SHA256 388512caf01af0380ff42e2fccecb488a277f923c61efb9e415d1f38779d9e4f
MD5 d4147f0e4374fcb513861a7f830035ed
BLAKE2b-256 44f1e546a6f4a09a35626ba26200b89ddeae5863941f57859b3a42b41d0036b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncoded-1.0.0.tar.gz:

Publisher: publish.yml on alimanfoo/uncoded

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

File details

Details for the file uncoded-1.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for uncoded-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd6546a391ea882b6833afcf49c282562b58bd1b332656504a45275281786214
MD5 4932edb3864842b286ee232a9b99974b
BLAKE2b-256 4a3cc858eeeedaf3779cd29bb24d2f4e0b648f655f573c021f59f9967edad8fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncoded-1.0.0-py3-none-any.whl:

Publisher: publish.yml on alimanfoo/uncoded

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