Skip to main content

A tool to generate Cursor IDE MDC files from repository analysis

Project description

Cursor MDC Generator

A tool to generate Cursor IDE documentation files (MDC) from repository analysis.

Installation

You can install the package using pip:

pip install cursor-mdc-generator

Or with uv:

uv install cursor-mdc-generator

Usage

To analyze a repository and generate MDC files:

# Analyze a local repository
cursor-mdc analyze --local-path /path/to/repository

# Analyze a remote repository
cursor-mdc analyze --repo-url https://github.com/user/repo

# Specify output directory
cursor-mdc analyze --repo-url https://github.com/user/repo --output-dir ./mdc-output

# Use a specific OpenAI model
cursor-mdc analyze --local-path /path/to/repo --model-name gpt-4

For private repositories:

cursor-mdc analyze --repo-url https://github.com/user/private-repo --oauth-token YOUR_GITHUB_TOKEN

Features

  • Analyzes repository structure and code dependencies
  • Creates dependency graphs to visualize relationships between files
  • Generates documentation files (MDC) for use with Cursor IDE
  • Supports both local and remote repositories
  • Compatible with various programming languages

Requirements

  • Python 3.7+
  • OpenAI API Key (set as environment variable OPENAI_API_KEY)

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

cursor_mdc_generator-0.1.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

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

cursor_mdc_generator-0.1.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file cursor_mdc_generator-0.1.0.tar.gz.

File metadata

  • Download URL: cursor_mdc_generator-0.1.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.6

File hashes

Hashes for cursor_mdc_generator-0.1.0.tar.gz
Algorithm Hash digest
SHA256 07f10613c4ff30f7f33bfa4af285983d547b791c17b1d84a9098175a169146c5
MD5 8d985b19a1d4e770caa046f190d81ba9
BLAKE2b-256 a2fc97c2b076b3d74ef1d817d62ecd3c4cfe84e3950e5b3b3e06b531dd108b8a

See more details on using hashes here.

File details

Details for the file cursor_mdc_generator-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cursor_mdc_generator-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55593e5f9466a8b2f8a282a12b979cf85a7d54087de5426de6cd00745befa0a3
MD5 20c4c7472c2539511e5b2312656ae7a3
BLAKE2b-256 c7a11dc10b96ee97afa2e79aa15c4c42405005ed491f07c77064b353c814db76

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