https://github.com/aweary/alder

A minimal implementation of the UNIX tree command with colors!
https://github.com/aweary/alder

command terminal

Last synced: 8 days ago
JSON representation

A minimal implementation of the UNIX tree command with colors!

• Host: GitHub
• URL: https://github.com/aweary/alder
• Owner: aweary
• License: mit
• Created: 2017-01-24T01:48:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-20T12:29:55.000Z (over 7 years ago)
• Last Synced: 2024-10-23T00:05:55.862Z (17 days ago)
• Topics: command, terminal
• Language: JavaScript
• Size: 50.8 KB
• Stars: 227
• Watchers: 3
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred-test - aweary/alder - A minimal implementation of the UNIX tree command with colors! (JavaScript)
• jimsghstars - aweary/alder - A minimal implementation of the UNIX tree command with colors! (JavaScript)

README

        
# alder 🌳

 A recursive directory listing program that supports file-size reporting, and pattern matching. Inspired by the [`tree`](http://www.computerhope.com/unix/tree.htm)

UNIX command.

![Alder: the better tree printer](http://i.imgur.com/8qhaxvG.png)

## Installation

`alder` should be installed globally using `yarn`.

```

yarn global add @aweary/alder

```

or with `npm`:

```

npm install -g @aweary/alder

```

## Usage

```

  Usage: alder [options] [target]

  Options:

    -h, --help           output usage information

    -a, --all            Print all files, including hidden files

    -d, --depth       Only render the tree to a specific depth

    -D, --directories    Only print directories

    -e, --exclude     Exclude files matching a pattern

    -f, --full           Print the full path prefix for each file

    -i, --no-indent      Tree will not print the indentation lines

    -I, --git-ignore     Exclude files in .gitignore

    -p, --include     Include only files that match a pattern

    -s, --sizes          Show file sizes in tree

    -t, --time-stamp     Print the last modified date for each file

    -V, --version        output the version number

    --prune              Prune empty directories from the output

    --filelimit       Do not descend directories that contain more than # entries

    --jsx                Print directory structure as JSX

```

### Exclude pattern

You can pass a string that will be parsed as a regular expression to `--exclude`:

```sh

# excluding single directory

alder --exclude=.git

# excluding multiple directories

alder --exclude=".git|bower_components|node_modules"

```

### Include pattern

You can pass a string that will be parsed as a regular expression to `--include`:

```sh

# including single file pattern

alder --include=package

# including multiple files patterns

alder --include="package|webpack"

```