Installation
Method 1: Go environment installation (recommended for developers)
- Prerequisites: Go language runtime installed
- Install the latest version:
go install github.com/tesserato/CodeWeaver@latest - Install the specified version:
go install github.com/tesserato/CodeWeaver@vX.Y.Z
Method 2: Pre-compile binaries
- Visit the GitHub Release page to download the executable for your system.
- Add execution permissions:
chmod +x codeweaver - It is recommended to move to the PATH path (e.g. /usr/local/bin)
Basic use process
- View Help::
codeweaver -hShow all parameter descriptions - Default Generation: Direct Execution
./codeweaverAutomatic scanning of the current directory - Parameter description::
- -dir: specifies the root directory to scan (defaults to the current directory)
- -output: customize output file name (default codebase.md)
- -ignore: set exclusion rules (supports regular expressions)
caveat
Windows users need to be aware:
- Path separators require a forward slash (/)
- Regular expressions need to be wrapped in double quotes
This answer comes from the articleCodeWeaver: Automatically generate Markdown documents from code structure and content.The
May not be reproduced without permission:AI productivity tools " How to install and use CodeWeaver?Please list the two main installation methods.
