安装方法
方法一:Go环境安装(推荐开发者)
- 前提:已安装Go语言运行时
- 安装最新版:
go install github.com/tesserato/CodeWeaver@latest
- 安装指定版本:
go install github.com/tesserato/CodeWeaver@vX.Y.Z
方法二:预编译二进制文件
- 访问GitHub Release页面下载对应系统的可执行文件
- 添加执行权限:
chmod +x codeweaver
- 建议移动到PATH路径(如/usr/local/bin)
基础使用流程
- 查看帮助:
codeweaver -h
显示所有参数说明 - 默认生成:直接执行
./codeweaver
自动扫描当前目录 - 参数说明:
- -dir:指定扫描根目录(默认为当前目录)
- -output:自定义输出文件名(默认codebase.md)
- -ignore:设置排除规则(支持正则表达式)
注意事项
Windows用户需注意:
• 路径分隔符需使用正斜杠(/)
• 正则表达式需用双引号包裹
本答案来源于文章《CodeWeaver:将代码结构和内容自动生成Markdown文档》