An open API service indexing awesome lists of open source software.

https://github.com/ruskydev/better-tree

A fast, customizable directory tree viewer for the terminal.
https://github.com/ruskydev/better-tree

better-tree cli command-line console dir-tree directory directory-tree file-structure file-system file-tree filesystem folder folder-tree fs node-cli recursive-list terminal tree

Last synced: 6 months ago
JSON representation

A fast, customizable directory tree viewer for the terminal.

Awesome Lists containing this project

README

          

# @ruskydev/better-tree

A fast, customizable directory tree viewer for the terminal.

## Installation

You can run it directly with `npx` (no install needed):

```bash
npx @ruskydev/better-tree --help
````

Or install globally:

```bash
npm install -g @ruskydev/better-tree
better-tree --help
```

## Usage

```bash
better-tree [directory] [options]
```

### Options

```
--ignore Ignore matching files/folders (supports *, **)
--depth Limit recursion depth
--files-only Show only files
--dirs-only Show only directories
--help Show this help message
```

### Examples

```bash
# Show current directory tree
npx @ruskydev/better-tree .

# Ignore node_modules and dist
npx @ruskydev/better-tree src --ignore node_modules dist

# Limit depth to 2
npx @ruskydev/better-tree --depth 2

# Show only directories
npx @ruskydev/better-tree --dirs-only
```

## License
This project is licensed under the [MIT License](LICENSE).