ai digest

ai-digest

Uma ferramenta CLI para agregar sua base de código em um único arquivo Markdown para uso com projetos Claude ou ChatGPTs personalizados.

Características

• Agrega todos os arquivos no diretório e subdiretórios especificados

• Ignora artefatos de construção e arquivos de configuração comuns

• Produz um único arquivo Markdown contendo toda a base de código

• Fornece opções para remoção de espaços em branco e padrões de ignorar personalizados

Como usar

Comece executando a ferramenta CLI no diretório do seu projeto:

 npx ai-digest

Isso irá gerar um arquivo codebase.md com sua base de código.

Depois de gerar o arquivo Markdown contendo sua base de código, você poderá usá-lo com modelos de IA como ChatGPT e Claude para análise e assistência de código.

Com ChatGPT:

1. Crie um GPT personalizado

2. Faça upload do arquivo Markdown gerado para a base de conhecimento do GPT

Com Cláudio:

1. Crie um novo projeto

2. Adicione o arquivo Markdown ao conhecimento do projeto

Para obter melhores resultados, carregue novamente o arquivo Markdown antes de iniciar uma nova sessão de bate-papo para garantir que a IA tenha a versão mais atualizada de sua base de código.

Opções

• -i, --input : Especifique o diretório de entrada (padrão: diretório atual)

• -o, --output : Especifique o arquivo de saída (padrão: codebase.md)

• --no-default-ignores : Desativa os padrões de ignorar padrão

• --whitespace-removal : Habilita a remoção de espaços em branco

• --show-output-files : exibe uma lista de arquivos incluídos na saída

• --ignore-file : Especifique um arquivo para ignorar personalizado (padrão: .aidigestignore)

• --help : Mostra ajuda

Exemplos

1. Uso básico:

    npx ai-digest

2. Especifique entrada e saída:

    npx ai-digest -i /caminho/para/seu/projeto -o project_summary.md

3. Habilite a remoção de espaços em branco:

    npx ai-digest --remoção de espaço em branco

4. Mostrar lista de arquivos incluídos:

    npx ai-digest --show-arquivos de saída

5. Combine várias opções:

    npx ai-digest -i /caminho/para/seu/projeto -o project_summary.md --whitespace-removal --show-output-files

Padrões de ignorar personalizados

ai-digest suporta padrões de ignorar personalizados usando um arquivo .aidigestignore no diretório raiz do seu projeto. Este arquivo funciona de forma semelhante a .gitignore , permitindo especificar arquivos e diretórios que devem ser excluídos da agregação.

Use o sinalizador --show-output-files para ver quais arquivos estão sendo incluídos, facilitando a identificação de candidatos à exclusão.

Remoção de espaços em branco

Ao usar o sinalizador --whitespace-removal , o ai-digest remove o excesso de espaços em branco dos arquivos para reduzir a contagem de tokens quando usado com modelos de IA. Este recurso está desabilitado para linguagens dependentes de espaços em branco, como Python e YAML.

Manipulação de arquivos binários e SVG

Arquivos binários e SVGs são incluídos na saída com uma nota sobre seu tipo de arquivo. Isso permite que os modelos de IA conheçam esses arquivos sem incluir seu conteúdo completo.

Desenvolvimento Local

Execute npm run start para executar a ferramenta CLI no projeto local. (Muito meta!)

Execute npm test para executar os testes.

Para passar sinalizadores para a CLI, use o sinalizador -- , assim: npm run start -- --whitespace-removal .

Implantar nova versão

npm publish

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para enviar uma solicitação pull.

Licença

Este projeto está licenciado sob a licença MIT.