Skip to main content

A modular toolkit for LLM-powered codebase understanding.

Project description

kit 🛠️ Code Intelligence Toolkit

kit is a production-ready Python toolkit for codebase mapping, symbol extraction, code search, and building LLM-powered developer tools, agents, and workflows.

Use kit to build things like code reviewers, code generators, even IDEs, all enriched with the right code context.

Work with kit directly from Python, or via MCP, with LLM function-calling, or (soon) from the kit REST server.

Quick Installation

Install from PyPI

# Standard installation (all features, including the kit-mcp server)
pip install cased-kit

Install from Source

git clone https://github.com/cased/kit.git
cd kit
uv venv .venv
source .venv/bin/activate
uv pip install -e .

Basic Usage

Python API

from kit import Repository

# Load a local repository
repo = Repository("/path/to/your/local/codebase")

# Load a remote public GitHub repo
# repo = Repository("https://github.com/owner/repo")

# Explore the repo
print(repo.get_file_tree())
# Output: [{"path": "src/main.py", "is_dir": False, ...}, ...]

print(repo.extract_symbols('src/main.py'))
# Output: [{"name": "main", "type": "function", "file": "src/main.py", ...}, ...]

Command Line Interface

kit also provides a comprehensive CLI for repository analysis and code exploration:

# Get repository file structure
kit file-tree /path/to/repo

# Extract symbols (functions, classes, etc.)
kit symbols /path/to/repo --format table

# Search for code patterns
kit search /path/to/repo "def main" --pattern "*.py"

# Find symbol usages
kit usages /path/to/repo "MyClass"

# Export data for external tools
kit export /path/to/repo symbols symbols.json

The CLI supports all major repository operations with Unix-friendly output for scripting and automation. See the CLI Documentation for comprehensive usage examples.

Key Features & Capabilities

kit helps your apps and agents understand and interact with codebases, with components to build your own AI-powered developer tools.

  • Explore Code Structure:

    • High-level view with repo.get_file_tree() to list all files and directories.
    • Dive down with repo.extract_symbols() to identify functions, classes, and other code constructs, either across the entire repository or within a single file.
  • Pinpoint Information:

    • Run regular expression searches across your codebase using repo.search_text().
    • Track specific symbols (like a function or class) with repo.find_symbol_usages().
  • Prepare Code for LLMs & Analysis:

    • Break down large files into manageable pieces for LLM context windows using repo.chunk_file_by_lines() or repo.chunk_file_by_symbols().
    • Get the full definition of a function or class off a line number within it using repo.extract_context_around_line().
  • Generate Code Summaries:

    • Use LLMs to create natural language summaries for files, functions, or classes using the Summarizer (e.g., summarizer.summarize_file(), summarizer.summarize_function()).
    • Build a searchable semantic index of these AI-generated docstrings with DocstringIndexer and query it with SummarySearcher to find code based on intent and meaning.
  • Analyze Code Dependencies:

    • Map import relationships between modules using repo.get_dependency_analyzer() to understand your codebase structure.
    • Generate dependency reports and LLM-friendly context with analyzer.generate_dependency_report() and analyzer.generate_llm_context().
  • And much more... kit also offers capabilities for semantic search on raw code, building custom context for LLMs, and more.

MCP Server

The kit tool includes an MCP (Model Context Protocol) server that allows AI agents and other development tools to interact with a codebase programmatically.

MCP support is currently in alpha. Add a stanza like this to your MCP tool:

{
  "mcpServers": {
    "kit-mcp": {
      "command": "python",
      "args": ["-m", "kit.mcp"]
    }
  }
}

The python executable invoked must be the one where cased-kit is installed. If you see ModuleNotFoundError: No module named 'kit', ensure the Python interpreter your MCP client is using is the correct one.

Documentation

Explore the Full Documentation for detailed usage, advanced features, and practical examples.

License

MIT License

Contributing

  • Local Development: Check out our Running Tests guide to get started with local development.
  • Project Direction: See our Roadmap for future plans and focus areas.

To contribute, fork the repository, make your changes, and submit a pull request.

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

cased_kit-0.3.3.tar.gz (94.3 kB view details)

Uploaded Source

Built Distribution

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

cased_kit-0.3.3-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

Details for the file cased_kit-0.3.3.tar.gz.

File metadata

  • Download URL: cased_kit-0.3.3.tar.gz
  • Upload date:
  • Size: 94.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for cased_kit-0.3.3.tar.gz
Algorithm Hash digest
SHA256 fa3e2674121e9b78a58395b4b1ca16c29ba73ef8c198bf37de9c7420b4dc0971
MD5 400655c9dc0a43dd0b796a23906ff0be
BLAKE2b-256 a3a987491b228bd28ed443b2131b0e9470deb2151167d7a0b1e85bdf7bd05889

See more details on using hashes here.

File details

Details for the file cased_kit-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: cased_kit-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 70.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for cased_kit-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 58ca6493c78462fee6e5dca34b05214d02871a5713f8caded728ce4f3aba6501
MD5 c48862d58ef3465b4ae2ceadf6e0c4fc
BLAKE2b-256 2d38246e984ef18b9b3a014a73924fd1cae207f9de5c0036909522515db09559

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