# dreel

> Global package to generate a directory and files tree

Latest version **1.0.6** (published 2023-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install dreel
pnpm add dreel
yarn add dreel
bun add dreel
```

Provides the command `dreel`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-05-24 |
| First published | 2023-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | jose.oliva |
| Maintainers | jose.oliva |
| Keywords | node, tree, directory, files |

## Links

- npm: https://www.npmjs.com/package/dreel
- Repository: https://github.com/joseoliva762/Dreel
- Homepage: https://github.com/joseoliva762/Dreel#readme
- Issues: https://github.com/joseoliva762/Dreel/issues
- npm.io page: https://npm.io/package/dreel

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2023-05-24
- 1.0.5 — 2023-05-24
- 1.0.4 — 2023-05-24
- 1.0.2 — 2023-05-24
- 1.0.1 — 2023-05-24
- 1.0.0 — 2023-05-24

## README

# Dreel: Árbol de Archivos y Carpetas en la Terminal

[![npm version](https://img.shields.io/npm/v/dreel.svg)](https://www.npmjs.com/package/dreel)

Una aplicación de línea de comandos que genera un árbol de archivos y carpetas en la terminal. Proporciona una representación visual de la estructura de directorios y archivos presentes en un directorio específico.

## Instalación

Asegúrate de tener [Node.js](https://nodejs.org) instalado en tu sistema. Luego, puedes instalar el paquete de npm globalmente utilizando el siguiente comando:

```shell
    npm install -g dreel
```

## Uso
Ejecuta el siguiente comando en la terminal para generar el árbol de archivos y carpetas:

```shell
    dreel <directorio>
```

Reemplaza <directorio> con la ruta del directorio que deseas explorar. Por ejemplo:

```shell
    dreel ./ruta/al/directorio
```

El paquete generará un árbol de archivos y carpetas en la terminal, mostrando la estructura del directorio especificado.

## Flags
El paquete proporciona las siguientes banderas para personalizar la salida:
- --omit-git: Omite los archivos y carpetas de Git.
- --omit-hidden: Omite los archivos y carpetas ocultos.
- --ommit-node-modules: Omite los archivos y carpetas de node_modules.
- --omit-all-files: Omite todos los archivos.

## Ejemplo
Supongamos que tienes la siguiente estructura de directorios y archivos:

```shell
    proyecto/
    ├── src/
    │   ├── index.js
    │   └── utils.js
    ├── public/
    │   └── index.html
    └── README.md
```

Para generar el árbol de archivos y carpetas en la terminal, ejecuta el siguiente comando:

```shell
    dreel ./proyecto
```

La salida en la terminal será:

```shell
    proyecto
    ├── src
    │   ├── index.js
    │   └── utils.js
    ├── public
    │   └── index.html
    └── README.md
```

## Contribución
Las contribuciones son bienvenidas. Si deseas mejorar este paquete, por favor, sigue estos pasos:

1. Haz un fork de este repositorio.
2. Crea una nueva rama para tus cambios: git checkout -b mi-mejora
3. Realiza los cambios y realiza commits: git commit -am 'Agrega una nueva funcionalidad'
4. Haz push a la rama: git push origin mi-mejora
5. Envía una pull request.

## Licencia
Este paquete está bajo la Licencia MIT.

## Contacto
Si tienes alguna pregunta, sugerencia o comentario, puedes contactarme a través de mi dirección de correo electrónico:
[itslivcode@gmail.com](itslivcode@gmail.com)

---
_Source: https://npm.io/package/dreel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._