db2md-cli

MySQL数据库文档生成工具, 支持生成markdown以及word文档

安装

1npm install -g db2md-cli

使用

1$ db2md help g
2Usage: db2md generate|g [options] <database> [type]
3
4generate a markdown or docx file against the database
5
6Arguments:
7  database                   Specifies the database name
8  type                       Specifies the type of file to be generated: md,docx
9
10Options:
11  -P, --password [password]  Database password (default: "root")
12  -H, --host [host]          Database host (default: "127.0.0.1")
13  -u, --username [username]  Database username (default: "root")
14  -p, --port [port]          Database host port (default: 3306)
15  -o, --output [output]      Document generation path, support for relative path
16  -f, --force                overwrite target file if it exists (default: false)
17  -h, --help                 Output usage information.

案例: sample

1db2md g -u root -p 3306 -P root -H 127.0.0.1 ark_admin md

使用root用户, 密码为root连接ark_admin数据库生成markdown文档, 默认会在当前路径下生成数据库名称.md.

如需生成word文档则将md替换为docx