Skip to main content

codeui

PyPI Version Python Version License: MIT Code Style

codeui is a universal, static-analysis-based code-intelligence library, defect detector, interactive graph visualizer, override store, and AI agent context builder.

It parses code bases safely without ever executing or importing analyzed code, extracting frozen intermediate representation (IR) graphs, tracing call hierarchies, detecting subtle architectural defects, and serving an interactive web visualizer.

Repository: https://github.com/AAlsubari/codeUI


Key Features

  • 100% Static Analysis: Safe AST extraction — NEVER executes, imports, or evaluates target project code.
  • Multi-Language Adapters: Native analyzers for Python, TypeScript, JavaScript, Go, Rust, Dockerfiles, Makefiles, and generic fallback parser.
  • Defect Detection Engine: 8 built-in static defect analyzers:
    • undefined: Missing symbols and functions
    • dead_code: Unreferenced private routines and unused exports
    • unresolved_import: Missing or invalid import paths
    • circular: Cyclic dependency detection via Tarjan's SCC algorithm
    • duplicates: Structural code clone identification via shingling
    • unreachable: Code following terminal control statements
    • shadowing: Variable shadowing across nested scopes
    • api_drift: Interface drift tracking against baseline snapshots
  • Interactive Localhost Visualizer: Force-directed multi-window canvas with live code editor, mini-map, symbol inspection, and direct disk edit toggle (http://127.0.0.1:3000).
  • Direct Disk & Non-Destructive Override Store: Save edits live to project disk files or non-destructively in an in-memory shadow store with unified diff generation (EditTools, OverrideStore).
  • AI Agent Context Engine: Graph-traversal based dynamic context bundling (ContextBuilder) optimized for LLM prompts without token counting overhead.
  • Agent Self-Contribution Workflow: Integrated ContributionManager allowing AI agents to dynamically fetch repository metadata, clone https://github.com/AAlsubari/codeUI, apply bug fixes or feature additions, and submit contributions.

Installation

Install via PyPI:

pip install codeui

Or install from source in editable mode:

git clone https://github.com/AAlsubari/codeUI.git
cd codeUI
pip install -e ".[dev]"

Quickstart

1. Command Line Interface (CLI)

# Scan a project directory and print summary
codeui scan .

# Start the interactive visualizer server
codeui serve . --port 3000

# Perform forward symbol call trace
codeui trace "src/app.py::main" . --direction forward --depth 3

# Generate AI Agent Context Bundle for a symbol
codeui context . --symbol "src/app.py::main"

# List detected code defects in SARIF format
codeui defects . --format sarif

# Apply direct disk edit to a file
codeui apply src/main.py --content "print('hello world')" --disk

# Submit automated contribution to codeui repo
codeui contribute --title "Fix import resolution bug" --file src/fix.py "content"

2. Python API Usage

from pathlib import Path
from codeui.cli.main import scan_project
from codeui.tracer.tracer import Tracer
from codeui.agent.context import ContextBuilder

# 1. Scan codebase into a Universal Graph
graph = scan_project(Path("."))

# 2. Perform Call Graph Tracing
tracer = Tracer(graph)
called_symbols = list(tracer.forward("src/main.py::run"))

# 3. Build Minimal Context Bundle for LLM Prompts
builder = ContextBuilder(graph)
bundle = builder.for_symbol("src/main.py::run", depth=2)
print(bundle.to_json())

AI Agent Self-Improvement Workflow

codeui provides first-class support for AI agents to automatically improve the library when encountering bugs, missing features, or optimization opportunities:

from codeui.agent.contribution import ContributionManager
from codeui.core.repo import get_library_repo_url

# Get official library repository URL (https://github.com/AAlsubari/codeUI)
repo_url = get_library_repo_url()

# Submit automated agent bug fix
mgr = ContributionManager()
result = mgr.submit_contribution(
    title="Agent: Add missing exception handling",
    description="Identified edge case in AST parser during project scan.",
    file_changes={"codeui/lang/python.py": "# fixed parser logic"},
    push=True,
)

Code Examples

Check out the examples/ folder for complete, runnable scripts:


Documentation

Full documentation is available in the docs/ directory:


License

codeui is released under the MIT License. Copyright (c) 2026 Akram Alsubari and codeui maintainers.

Release files for codeui-python 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for codeui-python 0.1.0
File Size Uploaded
codeui_python-0.1.0.tar.gz 69.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for codeui-python 0.1.0
File Interpreter ABI Platform
codeui_python-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 149.0 kB

Release files / codeui_python-0.1.0.tar.gz

Download URL codeui_python-0.1.0.tar.gz
Size 69.2 kB
Tags Source
SHA-256 checksum
How to use checksums
47617135be9bc7d0bdc42f80ddefc9462ff16c95441e7b05485784734c514636
BLAKE2b-256 checksum
How to use checksums
91995e4aab4535e172a894568161a05fdf587028b2440d850a088cc0a4ea1608
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / codeui_python-0.1.0-py3-none-any.whl

Download URL codeui_python-0.1.0-py3-none-any.whl
Size 79.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0cf37c14373615d6006f42529210188c44b3ff64398ec9ad129aa6e8320e236f
BLAKE2b-256 checksum
How to use checksums
45d81a4bac0dc8d1b2f781b1bfec6a6223a85b6fb121526c645b4561ab0804d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page