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
mdcgen-0.1.1.tar.gz
(26.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
mdcgen-0.1.1-py3-none-any.whl
(30.4 kB
view details)
File details
Details for the file mdcgen-0.1.1.tar.gz.
File metadata
- Download URL: mdcgen-0.1.1.tar.gz
- Upload date:
- Size: 26.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b8380ed9aed58fce615220dc8de5fbb9b9eafdfb755db38ac5a52d8fd431f44
|
|
| MD5 |
ebb6c7cc67674fd615ff279f22c09907
|
|
| BLAKE2b-256 |
7561752973929c473c8c6668a6f545fece050ec5c7b009b0c4f5dd70d3e605d7
|
File details
Details for the file mdcgen-0.1.1-py3-none-any.whl.
File metadata
- Download URL: mdcgen-0.1.1-py3-none-any.whl
- Upload date:
- Size: 30.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39f8a4d40b8562c3108c41655baa1d6eee81f06a499f3be7a7ed17a652991ac2
|
|
| MD5 |
fb4e836c07e98a63450bb1b0bb9b4d4d
|
|
| BLAKE2b-256 |
1d38d0000b22ba769b5ed60db3f61cac51c4eed06b5b946601184d2a20881b97
|