Flatty

Flatty-CodeBase-to-Text para LLMS

Transforme qualquer repo ou pasta do Github no seu Mac em um arquivo de texto simples para que você possa carregá -lo para um LLM (Claude, Chatgpt etc.) para raciocinar a coisa toda na janela de contexto.

CodeBase → Arquivos de texto (s)

LLMs como ChatGPT e Claude permitem fazer upload de arquivos, mas eles limitam quantos você pode fazer upload de uma só vez. Quando você está lidando com grandes bases de código com toneladas de arquivos, você não pode simplesmente carregá -las diretamente para um LLM. Você acaba tendo que usar técnicas de geração aumentada de RAG (recuperação), que na minha experiência não são tão eficazes quanto o upload de tudo na janela completa do contexto - especialmente quando você precisa raciocinar sobre arquitetura ou entender todo o sistema. Veja o exemplo.

Assistentes de codificação como o cursor são Amazeballs, mas eles funcionam melhor para a conclusão do código diário e as edições embutidas do que para o entendimento do sistema de nível superior.

Características

• Arquivo abrangente achatamento: converte bases de código inteiras em arquivos de texto estruturados adequados para LLMS.
• Manuseio de arquivos inteligente: ignora inteligentemente arquivos binários, imagens, cria artefatos, diretórios de pacotes, arquivos ocultos e arquivos do sistema.
• ****? Filtragem baseada em padrões: aprimore seu processo de achatamento, incluindo arquivos seletivamente com base em padrões de código específicos ou palavras-chave no conteúdo do arquivo e nos nomes de arquivos. Personalize seus critérios de inclusão usando AND / OR condições para direcionar exatamente o que você precisa para análise focada.

Instalação

Escolha sua aventura:

? ‍♂️ Instalação rápida (modo fácil)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash -s -- --quick

‍♂️ Instalação paranóica (verificações extras de segurança)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash

A instalação paranóica (padrão) inclui verificação de soma de verificação e verificações completas de segurança. A instalação rápida ignora esses cheques para a multidão "eu gosto de viver perigosamente".

Uso

O uso básico é estupidamente simples:

 cd your-project-directory
flatty

Isso cria um arquivo de texto bem formatado em ~/Documents/flatty/ contendo todos os arquivos de texto do seu projeto, pronto para o consumo de LLM.

Filtragem baseada em padrões

Assuma o controle do que é incluído na sua saída achatada especificando padrões e condições. Esse recurso permite que você se concentre em partes específicas da sua base de código, melhorando a eficiência e a relevância.

Argumentos da linha de comando:

• --pattern "pattern1" : especifique um padrão ou palavra-chave para filtrar arquivos. Você pode usar sinalizadores múltiplos --pattern para vários padrões.
• --condition AND|OR : Defina como vários padrões devem ser correspondidos.
  • AND : todos os padrões especificados devem estar presentes em um arquivo (no nome do arquivo ou no conteúdo).
  • OR : qualquer um dos padrões especificados deve estar presente.

Exemplos:

1. Inclua arquivos que contêm a função useEffect ou async function :

   flatty --pattern " useEffect " --pattern " async function " --condition OR

2. Inclua arquivos que contêm a função useEffect e async function :

   flatty --pattern " useEffect " --pattern " async function " --condition AND

3. Inclua arquivos com README no nome do arquivo:

   flatty --pattern " README " --condition OR

4. Comportamento padrão sem padrões (inclui todos os arquivos de texto elegíveis):

   flatty

Comportamento:

• Ou condição: os arquivos estão incluídos se algum dos padrões especificados for encontrado no nome do arquivo ou do arquivo.
• E condição: os arquivos são incluídos apenas se todos os padrões especificados forem encontrados no nome do arquivo ou do arquivo.
• Sem padrões especificados: os padrões de incluir todos os arquivos de texto elegíveis, mantendo o comportamento original.

Manuseio de arquivos inteligente

Skips de forma inteligente:

• Arquivos e imagens binárias
• Construir artefatos
• Diretórios de pacote ( node_modules , vendor )
• Arquivos ocultos e .git
• Arquivos do sistema ( .DS_Store )

Saída

Os arquivos de texto achatados são salvos no diretório ~/flattened/ com nomes de arquivos formatados como:

 <project-name>-v<version>-<timestamp>.txt

Cada arquivo de saída inclui:

• Informações do projeto e metadados
• Estrutura completa do repositório com diretórios e contagens de token de arquivo
• Conteúdo de cada arquivo de texto incluído, separado por separadores definidos

Desenvolvimento

Desenvolvido com ❤️ por talktastic

Contribuindo

As contribuições são bem -vindas! Abra um problema ou envie uma solicitação de tração para aprimoramentos ou correções de bugs.

Ganchos git

Para manter a integridade do script flatty.sh e verifique se o arquivo de soma de verificação ( flatty.sh.sha256 ) está sempre atualizado, os colaboradores devem configurar um gancho Git pré-comprometido. Esse gancho gera e atualiza automaticamente a soma de verificação antes de cada confirmação.

Etapas para configurar o gancho de pré-compromisso:

1. Navegue até o diretório Git Hooks:

    cd .git/hooks

2. Crie ou edite o gancho pre-commit :

   cursor pre-commit

3. Adicione o script a seguir ao arquivo pre-commit :

    #! /bin/bash
   
   # Generate SHA256 checksum for flatty.sh
   sha256sum flatty.sh > flatty.sh.sha256
   
   # Add the checksum file to the commit
   git add flatty.sh.sha256

4. Faça o gancho executável:

   chmod +x pre-commit

Explicação: Este gancho garante que toda vez que flatty.sh seja modificada e uma confirmação seja feita, o arquivo de soma de verificação correspondente flatty.sh.sha256 é atualizado automaticamente e incluído no Commit. Isso mantém o processo de verificação de integridade para o script de instalação.

Licença

Mit