Skip to main content

CodeMind OKF CLI — Generate AI-ready knowledge bundles for any codebase. Works with Cursor, Antigravity, GitHub Copilot, and any MCP-compatible AI IDE.

Project description

🧠 CodeMind OKF CLI

Generate AI-ready knowledge bundles for any codebase.
Works with Cursor, Antigravity IDE, Claude Desktop, GitHub Copilot, and any MCP-compatible AI IDE.

PyPI Version Python Versions MCP Compatible


📦 Installation

pip install codemind-okf

🚀 Quick Usage

1. codemind index — Index Any Project

Crawls your project files using Tree-sitter & AST parsers to generate a .okf/ knowledge bundle.

codemind index .                         # Index current directory
codemind index /path/to/project          # Index a specific directory
codemind index . --lang python           # Only index Python files
codemind index . --overwrite             # Force re-index from scratch
  • ⚡ SHA-256 Incremental Indexing: Remembers file hashes. Subsequent runs skip unchanged files in 0.05s!

2. codemind init — Drop AI IDE Instructions

Creates instruction files so Cursor, Antigravity, and GitHub Copilot use .okf/index.md as primary context.

codemind init                            # Create all AI IDE config files

Files created:

File Compatible Tool
.cursorrules Cursor AI IDE
.agents/AGENTS.md Antigravity IDE & Open Agents
.github/copilot-instructions.md GitHub Copilot

3. codemind audit — Architecture & Health Audit

Performs an architectural health check evaluating line density, docstring coverage, and layer separation.

codemind audit                          # Health score (0-100 A+)

4. codemind watch — Real-Time Background File Watcher

Watches the project directory for file saves and incrementally updates .okf/ in under 50ms.

codemind watch                          # Run watcher in background

5. codemind mcp — Model Context Protocol (MCP) Server

Launches the MCP server over STDIO. Connects CodeMind natively to Cursor, Claude Desktop, Antigravity, or Zed.

codemind mcp

Add to Cursor / Claude Desktop / Antigravity (mcp.json):

{
  "mcpServers": {
    "codemind": {
      "command": "uvx",
      "args": [
        "--from",
        "codemind-okf",
        "codemind",
        "mcp"
      ]
    }
  }
}

6. codemind memory — Manage AI Persistent Memory Log (.okf/memory.md)

Inspect, view, clear, or manually log memory entries to .okf/memory.md.

codemind memory show                     # Print full memory log
codemind memory ls                       # Show entry summary by type
codemind memory add "..." --type decision# Manually append memory entry
codemind memory clear                    # Reset memory log

🔌 Exposed MCP Tools

MCP Tool Description
🧠 remember(content, type) Persists AI decisions, tasks, context & bugs into .okf/memory.md
🔄 recall(query) Retrieves relevant past memories at session start to eliminate context loss
📚 get_project_index Reads the master architecture map (index.md)
🔍 search_bundle(query) Sub-word & token search across all project modules
📖 read_module(slug) Reads specific module AST metadata & function signatures
🔗 trace_dependencies(slug) Traces import graphs between components
📁 list_bundles Discovers available .okf/ knowledge bundles

📄 License

MIT License. See repository 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

codemind_okf-1.2.0.tar.gz (42.1 kB view details)

Uploaded Source

Built Distribution

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

codemind_okf-1.2.0-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file codemind_okf-1.2.0.tar.gz.

File metadata

  • Download URL: codemind_okf-1.2.0.tar.gz
  • Upload date:
  • Size: 42.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for codemind_okf-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0ebd946b1010fec78951f2cc4825e0b0482f9a994bb744c07ba3a8554258b11e
MD5 f4c53f31543923241b8a40ed49d13edf
BLAKE2b-256 c5627f2b91045687da8232ea30bdf23f0cb84d2491185ca724e63f17204791af

See more details on using hashes here.

File details

Details for the file codemind_okf-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: codemind_okf-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 49.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for codemind_okf-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a391b733b071c2e019b42c122e2d2e8bbda0735e65f7ed6147451534bf90b76
MD5 4ceac634b11560c2f6c68a1b21202ed2
BLAKE2b-256 24e764a3f404fab70ee390b82ac512476cc1bab04678f2e371b76013ccad1990

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