🚀 快速上手
⚠️ 重要提示: 使用本工具时，请确保遵守数据安全法规和公司政策，仅在获得授权的情况下访问数据库，并对生成的文档采取适当的安全保护措施。
前提条件
- Go 1.24+ 或更高版本（仅源码编译需要）
- 支持的目标数据库（MySQL、PostgreSQL、Oracle 或 SQLite）
- 数据库连接权限（建议在测试环境使用）
安装方式
方式一：下载预编译二进制文件（推荐）
从 Release 页面下载适用于您操作系统的最新预编译版本：
- Windows: GenDict_Windows_x86_64.zip
- Linux: GenDict_Linux_x86_64.tar.gz
- macOS: GenDict_macOS_x86_64.tar.gz
下载后解压即可使用，无需额外依赖。
方式二：从源码编译安装
# 克隆项目代码
git clone https://github.com/ourcolour/GenDict.git
cd GenDict
# 编译并安装
go mod download
go build -o gen-dict main.go
# 将可执行文件移动到 PATH 环境变量包含的目录中，例如
sudo mv gen-dict /usr/local/bin/
基本用法
- 启动应用程序：
gen-dict
配置连接：在GUI界面中输入数据库连接信息
- 主机地址、端口号
- 数据库名称
- 用户名和密码
- 数据库类型（自动检测）
设置输出：
- 选择输出格式（Excel/Markdown）
- 指定保存路径
生成文档：点击"生成"按钮，等待完成后查看输出文件
📋 支持的数据库
当前工具支持以下数据库类型。
| 数据库 | 支持状态 | 版本要求 | 支持特新 |
|---|---|---|---|
| MySQL | ✅ 支持 | 5.7+ | 表、视图、索引、注释 |
| SQLServer | ✅ 支持 | 2008+ | 表、视图、索引、注释 |
| PostgreSQL | ✅ 支持 | 9.6+ | 表、视图、索引、注释 |
| Oracle | ✅ 支持 | 11g+ | 表、视图、索引、注释 |
| SQLite | ✅ 支持 | 3.0+ | 表、索引 |