🧰 shtoolkit

CLI moderna para explorar, filtrar e copiar conteúdo de projetos com consistência e simplicidade.

🇺🇸 Read in English

✨ Features

• 🌳 Gerar árvore de diretórios (tree)
• 📋 Copiar conteúdo de arquivos (copy-content / cpc)
• ⚙️ Configuração via .shtk.json (para tree)
• 🔍 Regras de ignore por nome, pasta e glob
• 📦 Saída em JSON e YAML
• 📊 Estatísticas detalhadas
• 🚫 Tratamento de erros robusto

📦 Instalação

Global

npm install -g @byetevinn/shtoolkit

Usando npx

npx @byetevinn/shtoolkit tree

🚀 Comandos

🌳 Tree

Gera a estrutura do projeto.

shtk tree

👉 Documentação: tree

📋 Copy Content (cpc)

Copia conteúdo de arquivos a partir dos caminhos informados.

shtk cpc src

👉 Documentação: copy-content

⚙️ Init

Inicializa o arquivo de configuração.

shtk init

👉 Documentação: init

📚 Documentação

• Getting Started
• Commands

⚙️ Configuração

Execute:

shtk init

Isso cria o arquivo .shtk.json, utilizado pelo comando tree.

ℹ️ Observação: copy-content NÃO utiliza .shtk.json — ele segue apenas os caminhos informados.

🧠 Regras de Ignore

names

Ignora arquivos/pastas em qualquer nível

"names": ["node_modules", ".git"]

filesIn

Ignora arquivos dentro de pastas específicas

"filesIn": ["screenshots", "src/temp/uploads"]

patterns

Suporte a glob

"patterns": ["*.log", "*.tmp"]

📊 Exemplo de Saída

JSON

{
  "name": "project",
  "type": "folder",
  "children": []
}

YAML

name: project
type: folder
children: []

📈 Exemplo de Estatísticas

📊 Copy Content Result

📁 Total Files : 23
✅ Processed   : 23
⏭ Skipped     : 0
❌ Errors      : 0
📄 Total Lines : 1213

🧪 Casos de Uso

• Preparar contexto para IA (ChatGPT, etc)
• Gerar documentação de projetos
• Analisar estrutura de código
• Debug de arquivos

🛠 Roadmap

• [ ] Saída em Markdown
• [ ] Flag --flat
• [ ] Integração com .gitignore
• [ ] Suporte a múltiplos diretórios

👤 Autor

Desenvolvido por Stevan Padilha

📝 Licença

MIT