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 from any codebase. Works with Cursor, Antigravity, GitHub Copilot, and any MCP-compatible AI IDE.

Install

pip install codemind-okf

Quick Start

# 1. Navigate to your project
cd my-project

# 2. Generate the OKF knowledge bundle (zero LLM cost — pure AST)
codemind index .

# 3. Drop AI IDE config files so Cursor/Antigravity/Copilot use the bundle
codemind init

# 4. Open your IDE — AI now reads .okf/index.md as its primary context!

Commands

codemind index <path>

Crawls and indexes a project into an .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             # Re-index from scratch

codemind init

Drops AI IDE instruction files that tell Cursor, Antigravity, and Copilot to use .okf/ as context.

codemind init                            # Create all AI IDE config files
codemind init --no-copilot              # Skip GitHub Copilot instructions

Files created:

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

codemind status

Show the current bundle statistics.

codemind status
codemind status /path/to/project

codemind watch

Watches the project directory for real-time file changes and updates .okf/ incrementally in milliseconds.

codemind watch                          # Watch current directory

codemind audit

Performs an architectural health and code density audit of your codebase using your OKF bundle.

codemind audit                          # Audit current project codebase

codemind mcp

Launches the Model Context Protocol (MCP) server over STDIO.

Connects CodeMind natively to Cursor, Claude Desktop, Antigravity, or Zed.

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

{
  "mcpServers": {
    "codemind": {
      "command": "codemind",
      "args": ["mcp"]
    }
  }
}

Once configured, Cursor or Claude Desktop will automatically call CodeMind tools (search_bundle, read_module, get_project_index, trace_dependencies) whenever you ask questions about your codebase!

How It Works

Your Codebase  →  AST Parser  →  ModuleSummary  →  .okf/modules/*.md
                                                    .okf/index.md
                                                    .okf/log.md
                                                           ↓
                              AI IDE reads .cursorrules → reads .okf/index.md
                              → understands full architecture instantly

All parsing is deterministic and free — no LLM calls, no API keys required.

Output Structure

.okf/
├── index.md              ← Master architecture map (AI IDE reads this first)
├── log.md                ← Generation audit trail
└── modules/
    ├── src-auth-router.md
    ├── src-database-models.md
    └── src-api-endpoints.md

Each module file contains structured YAML frontmatter:

---
type: api
title: Auth Router
description: Handles user authentication endpoints including login, logout, and token refresh.
resource: src/auth/auth_router.py
tags:
  - api
  - auth
  - fastapi
key_functions:
  - login
  - logout
  - refresh_token
timestamp: 2025-07-23
---

Supported Languages

  • Python (.py) — Full AST analysis
  • JavaScript (.js, .jsx) — AST + regex parsing
  • TypeScript (.ts, .tsx) — AST + regex parsing

License

MIT © CodeMind

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.0.2.tar.gz (25.7 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.0.2-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for codemind_okf-1.0.2.tar.gz
Algorithm Hash digest
SHA256 269840446f73e93ae85409b90bf51410c20e432d7895759e12db9905ef45d9b1
MD5 4c6f95f0ab29ee60ae7dc0407830c3c6
BLAKE2b-256 7e134aa0323e2deae8572de7f91c50f4eb9710265bbd3ed6bb5966844ea46562

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for codemind_okf-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3c4e75abb1b28c9b1d4724892ebaa59a0700c32cdf22a965ea2fe16c79ab1d7c
MD5 5c761abacd59500b32b85976a980481f
BLAKE2b-256 f41c4441306f9a48acc9b292062ae1bf3c13fecf48528b854171090221e98187

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