https://github.com/fabiosmuu/tgen
Ferramenta CLI para visualizar e reconstruir árvores de diretórios.
https://github.com/fabiosmuu/tgen
cli developer-tools directory-tree filesystem javascript mit-license nodejs productivity smuu terminal tree
Last synced: 27 days ago
JSON representation
Ferramenta CLI para visualizar e reconstruir árvores de diretórios.
- Host: GitHub
- URL: https://github.com/fabiosmuu/tgen
- Owner: FabioSmuu
- License: mit
- Created: 2025-07-18T03:48:32.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-18T10:43:01.000Z (11 months ago)
- Last Synced: 2025-07-18T14:35:56.579Z (11 months ago)
- Topics: cli, developer-tools, directory-tree, filesystem, javascript, mit-license, nodejs, productivity, smuu, terminal, tree
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tgen
[](https://opensource.org/licenses/MIT) [](https://nodejs.org/) [](#)
---
## O que é?
`tgen` é uma ferramenta CLI para **gerar e recriar árvores de diretórios** a partir de uma estrutura física ou de um arquivo texto com o formato da árvore.
Eu criei este projeto porque uso muito agentes de IA no meu dia a dia e frequentemente me deparo com a necessidade de compartilhar a estrutura de arquivos dos meus projetos. Criar isso manualmente é cansativo e demorado.
No começo, só queria uma função que criasse pastas e arquivos placeholder, mas como precisava enviar para a IA uma visão clara da estrutura do meu projeto, resolvi também criar um visualizador de árvore, parecido com o `tree` do Windows.
Assim, além de evitar baixar projetos prontos que não atendem exatamente às minhas necessidades, eu posso personalizar a ferramenta do meu jeito!
---
### Como usar (Windows, Linux e macOS)
É simples. Basta clonar o repositório, entrar na pasta e criar o link global com o npm:
```bash
git clone https://github.com/FabioSmuu/tgen.git
cd tgen
npm link
```
Isso irá criar um comando global **tgen** que pode ser usado em qualquer lugar no seu terminal.
### Como remover o link global
Se quiser remover o link global, também é simples:
```bash
npm unlink -g tgen
```
# Exemplos de uso
---
> Antes de mais nada, use `tgen -h` para ver todos os parametros do projeto.
Gerar a árvore de diretórios de uma pasta e mostrar no terminal:
```bash
tgen ./meuProjeto
```
Gerar a árvore e salvar em um arquivo:
```bash
tgen ./meuProjeto -o ./saida/tree.txt
```
Recriar estrutura a partir de um arquivo tree.txt (criando só pastas):
```bash
tgen ./path/tree.txt -o ./novaEstrutura
```
Recriar estrutura com pastas e arquivos placeholders (com a flag -a):
```bash
tgen ./path/tree.txt -o ./novaEstrutura -a
```
Recriar estrutura lendo do stdin (pipe):
```bash
cat ./path/tree.txt | tgen -o ./novaEstrutura -a
```
Por padrão o CLI já ignora a pasta `node_modules`, mas você pode ignorar outros arquivos/diretorios:
```bash
tgen ./meuProjeto -i .ignore
```
**Obrigado pela sua atenção!**