Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 2.71 KB

README.md

File metadata and controls

120 lines (79 loc) · 2.71 KB
Raw

nodetree

list contents of directories in a tree-like format similar to the Tree Command.

SYNOPSIS

nodetree [-ad] [-L <level>] [--noreport] [--version] [--help] [--prune] [<directory> ...]

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.

INSTALL

$ npm install --save nodetree

NODE

With defaults:

var nodetree = require('nodetree');
nodetree(process.cwd());

With all options set:

var nodetree = require('nodetree');
nodetree(process.cwd(), {
  all: false,
  directories: false,
  level: 2,
  prune: false,
  noreport: false
});

CLI

$ npm install -g nodetree
$ 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 or the Changelog if you have any questions.

AUTHOR

Written by Larry Gordon

COPYRIGHT

The MIT License (MIT)