https://github.com/derycktse/treer

Treer is a commandline tool to generate directory structure tree
https://github.com/derycktse/treer

Last synced: 12 days ago
JSON representation

Treer is a commandline tool to generate directory structure tree

• Host: GitHub
• URL: https://github.com/derycktse/treer
• Owner: derycktse
• License: mit
• Created: 2017-03-27T07:51:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-14T08:46:47.000Z (over 5 years ago)
• Last Synced: 2024-05-28T15:04:00.053Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 95
• Watchers: 2
• Forks: 19
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## treer ##

Treer is a commandline tool to generate directory structure tree



## install ##

```

$ npm install treer -g

```

## usage ##

```

$ treer --help

  Usage: treer [options]

  Options:

    -h, --help             output usage information

    -V, --version          output the version number

    -d, --directory [dir]  Please specify a directory to generate structure tree

    -i, --ignore [ig]      You can ignore specific directory name

    -e, --export [epath]   export into file

```

## Available Options: ##

`-d` Specify a directory path to generate it's structure tree

`-i` or `--ignore` the directory name pattern to skip, it also support regex:

```

$ treer -i "/^regex$/"

```

`-e` or `--export` export into file

### example: ###

```

$ treer -e ./result.txt -i .git

treer

├─.DS_Store

├─.gitignore

├─README.md

├─package.json

├─result.txt

├─src

|  └index.js

├─node_modules

|      ├─graceful-readlink

|      |         ├─.npmignore

|      |         ├─.travis.yml

|      |         ├─LICENSE

|      |         ├─README.md

|      |         ├─index.js

|      |         └package.json

|      ├─commander

|      |     ├─History.md

|      |     ├─LICENSE

|      |     ├─Readme.md

|      |     ├─index.js

|      |     └package.json

The result has been saved into ./result.txt

```