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

mdcgen-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.

mdcgen-0.1.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdcgen-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 mdcgen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 772450d16d1982571e7f69c29ec6214e8ae772bba6086a54a6dd12b36927d110
MD5 3d3592c4ca391f133e89e324e9e4cf55
BLAKE2b-256 7b497c020232430eca19cf58c6a20a951d8abe5d55730337e25d4c6aa986e4b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdcgen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.6

File hashes

Hashes for mdcgen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a2e088593a2f298e7a42672ac97983ac0311b6af48c776b53fbef7b8fcff7c
MD5 0df0828faf9fe69f45b931877a5d56d7
BLAKE2b-256 5d4726943d957c89e6183a45a237c9ab63e25da9da44cf6045f4f8384f15bbb3

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