I am using a Windows 10 machine and was able to easily do the installation by using run go install github.com/tesserato/CodeWeaver@latest.
The issue is none of the following given commands work.
chmod +x codeweaver
Generate documentation for the current directory:
./codeweaver
This will create a file named codebase.md in the current directory, documenting the structure and content of the current directory and its subdirectories (excluding paths matching the default ignore pattern .git.*).
Specify a different input directory and output file:
./codeweaver -dir=my_project -output=project_docs.md
This command will process the my_project directory and save the documentation to project_docs.md.
Ignore specific file types and directories:
./codeweaver -ignore="\.log,temp,build" -output=detailed_docs.md
This example will generate detailed_docs.md, excluding any files or directories with names containing .log, temp, or build. Regular expression patterns are comma-separated.
Save lists of included and excluded paths:
./codeweaver -ignore="node_modules" -included-paths-file=included.txt -excluded-paths-file=excluded.txt -output=code_overview.md
I am using a Windows 10 machine and was able to easily do the installation by using
run go install github.com/tesserato/CodeWeaver@latest.The issue is none of the following given commands work.
chmod +x codeweaverGenerate documentation for the current directory:
./codeweaverThis will create a file named codebase.md in the current directory, documenting the structure and content of the current directory and its subdirectories (excluding paths matching the default ignore pattern .git.*).
Specify a different input directory and output file:
./codeweaver -dir=my_project -output=project_docs.mdThis command will process the my_project directory and save the documentation to project_docs.md.
Ignore specific file types and directories:
./codeweaver -ignore="\.log,temp,build" -output=detailed_docs.mdThis example will generate detailed_docs.md, excluding any files or directories with names containing .log, temp, or build. Regular expression patterns are comma-separated.
Save lists of included and excluded paths:
./codeweaver -ignore="node_modules" -included-paths-file=included.txt -excluded-paths-file=excluded.txt -output=code_overview.md