Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psyrendust/nodetree
List contents of directories in a tree-like format similar to the Tree Command (http://mama.indstate.edu/users/ice/tree/.
https://github.com/psyrendust/nodetree
Last synced: 3 months ago
JSON representation
List contents of directories in a tree-like format similar to the Tree Command (http://mama.indstate.edu/users/ice/tree/.
- Host: GitHub
- URL: https://github.com/psyrendust/nodetree
- Owner: psyrendust
- Created: 2014-07-07T19:19:20.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-20T17:15:15.000Z (over 6 years ago)
- Last Synced: 2024-03-19T02:04:45.489Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Lists
- awesome-nodejs-cross-platform-cli - nodetree - List contents of directories like `tree`. (Packages)
README
# nodetree
> list contents of directories in a tree-like format similar to the [Tree Command](http://mama.indstate.edu/users/ice/tree/).
## SYNOPSIS
`nodetree` \[`-ad`\] \[`-L` \] \[`--noreport`] \[`--version`] \[`--help`] \[`--prune`] \[\ ...]
## DESCRIPTION
_Nodetree_ is a recursive directory listing program that produces a depth indented listing of files. With no arguments, _nodetree_ lists the files in the current directory. When directory arguments are given, _nodetree_ lists all the files and/or directories found in the given directories each in turn. Upon completion of listing all files/directories found, _nodetree_ returns the total number of files and/or directories listed. _Nodetree_ is heavily inspired by the [Tree Command](http://mama.indstate.edu/users/ice/tree/).
## INSTALL
```sh
$ npm install --save nodetree
```
## NODE
With defaults:
```js
var nodetree = require('nodetree');
nodetree(process.cwd());
```
With all options set:
```js
var nodetree = require('nodetree');
nodetree(process.cwd(), {
all: false,
directories: false,
level: 2,
prune: false,
noreport: false
});
```
## CLI
```sh
$ npm install -g nodetree
```
```sh
$ man nodetree
```
## OPTIONS
_Nodetree_ understands the following command line switches:
## NODE OPTIONS
### nodetree(basepath, options)
#### options.all
Type: `Boolean`
Default: `false`
See cli option `-a` below.
#### options.directories ####
Type: `Boolean`
Default: `false`
See cli option `-d` below.
#### options.level
Type: `int`
Default: `null`
See cli option `-L` below.
#### options.prune
Type: `Boolean`
Default: `false`
See cli option `--prune` below.
#### options.noreport
Type: `Boolean`
Default: `false`
See cli option `--noreport` below.
## CLI OPTIONS
* `-a`:
All files are printed. By default tree does not print hidden files (those beginning with a dot '.'). In no event does tree print the file system constructs '.' (current directory) and '..' (previous directory).
* `-d`:
List directories only.
* `-L` :
Max display depth of the directory tree.
* `--prune`:
Makes tree prune empty directories from the output.
* `--noreport`:
Omits printing of the file and directory report at the end of the tree listing.
* `--version`:
Outputs the version of nodetree.
## NEED HELP?
Feel free to read the [Contributing Guide][contributing] or the [Changelog][changelog] if you have any questions.
## AUTHOR
Written by Larry Gordon
## COPYRIGHT
[The MIT License (MIT)](http://psyrendust.mit-license.org/2014)
[changelog]: https://github.com/psyrendust/nodetree/blob/master/CHANGELOG.md
[contributing]: https://github.com/psyrendust/nodetree/blob/master/CONTRIBUTING.md