Catalogue-MD-Generate

本项目代码全部由Cursor生成。

一个基于Node.js的命令行工具，用于生成项目目录结构的Markdown文档。

功能特点

• 根据指定的项目根目录，生成该项目的文件目录结构
• 支持表格和树形两种展示格式
• 支持设置多个排除文件夹或文件，支持通配符匹配
• 支持设置只生成文件夹，不包含文件
• 内置常见排除项（如node_modules、.git等）
• 支持设置最大遍历深度
• 支持设置输出文件路径

安装

全局安装（推荐）：

npm install -g catalogue-md-generate

或者本地安装：

npm install catalogue-md-generate

使用方法

命令行使用

# 在当前目录生成目录结构（表格形式）
catmd

# 使用树形结构显示
catmd --tree

# 指定项目根目录
catmd --path /path/to/your/project

# 指定输出文件名
catmd --output directory-structure.md

# 排除特定文件或目录
catmd --exclude node_modules .git "*.log"

# 只包含目录，不包含文件
catmd --directories-only

# 设置最大深度
catmd --max-depth 3

# 组合使用多个选项
catmd --path /path/to/project --exclude node_modules --tree --output structure.md

选项说明

• -p, --path <path>: 项目根目录路径（默认为当前工作目录）
• -o, --output <output>: 输出文件名（默认为catalogue.md）
• -e, --exclude <patterns...>: 排除的文件或目录模式，支持通配符
• -d, --directories-only: 只包含目录，不包含文件
• -i, --include <patterns...>: 只包含的文件或目录模式，支持通配符
• -m, --max-depth <depth>: 最大遍历深度
• -t, --tree: 使用树形结构显示（默认为表格形式）
• -v, --version: 显示版本号
• -h, --help: 显示帮助信息

示例输出

表格形式

# 项目目录结构

| 路径 | 说明 |
| --- | --- |
| 📁 src/ | |
| 📁 src/components/ | |
| 📄 src/index.js | |
| 📄 package.json | |
| 📄 README.md | |

树形结构

# 项目目录结构

src/
├── components/
│   └── Button.js
├── utils/
│   └── helpers.js
└── index.js

许可证

ISC