Instalação
Método 1: Instalação no ambiente (recomendado para desenvolvedores)
- Pré-requisitos: tempo de execução da linguagem Go instalado
- Instale a versão mais recente:
go install github.com/tesserato/CodeWeaver@latest - Instale a versão especificada:
go install github.com/tesserato/CodeWeaver@vX.Y.Z
Método 2: Pré-compilar binários
- Visite a página de versão do GitHub para fazer o download do executável para seu sistema.
- Adicione permissões de execução:
chmod +x codeweaver - Recomenda-se mover para o caminho PATH (por exemplo, /usr/local/bin)
Processo de uso básico
- Exibir ajuda::
codeweaver -hMostrar todas as descrições de parâmetros - Geração padrãoExecução direta
./codeweaverVarredura automática do diretório atual - Descrição do parâmetro::
- -dir: especifica o diretório raiz a ser examinado (o padrão é o diretório atual)
- -output: nome do arquivo de saída personalizado (padrão codebase.md)
- -ignore: define regras de exclusão (suporta expressões regulares)
advertência
Os usuários do Windows precisam estar cientes:
- Os separadores de caminho exigem uma barra (/).
- As expressões regulares precisam ser colocadas entre aspas duplas
Essa resposta foi extraída do artigoCodeWeaver: gere automaticamente documentos Markdown a partir da estrutura e do conteúdo do código.O































