Skip to content

Commit

Permalink
Some changes in the README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc de Palol committed Jul 17, 2013
1 parent c860f57 commit 7c25680
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,39 @@ This is a simple standalone tool that emulates the Unix 'tree' command in HDFS.

## USAGE

To use it just copy the tool, add it to your path and:
To use it just copy the tool, add it to your path it's ready to use, it has 3 options:

* -p: Specifies the root path. This is mandatory.
* -l: Specifies that you want to use the local filesystem instead of HDFS:
* -s: Specifies that you want to see the size (in human readable format) next to each directory.

some examples:

hdfstree -p /
This will print all the HDFS tree
This will print all the HDFS tree. This will take some time...

hdfstree -p /user/marc/
Print all the directories starting from /user/marc

hdfstree -l -p /Users/marc/Music
Print all the directories in the local filesystem.

hdfstree -l -p /Users/marc/Music -s
Print all the directories in the /Users/marc/Music directory in the local filesystem and display the sizes.

The output is pretty much like the unix tree command. Have an example:

└──/Users/marc/work/hdfstree
├──.git
| ├──branches
| ├──hooks
| ├──info
| ├──logs
| | └──refs
| | ├──heads
| | | └──mdepalol
| | └──remotes
| | └──origin
| ├──objects
...

## BUILDING & SOURCE

Build is done with [gradle](http://www.gradle.org/). To create a ready to use script with the libraries just use:
Expand All @@ -25,4 +47,4 @@ You'll get the executable script + the libraries in

hdfstree/build/install/hdfstree


just add this directory (hdfstree/build/install/hdfstree/bin) to your PATH variable and you are done, also, make sure you have the HADOOP\_HOME environment variable set. The program will complain if you don't have it.

0 comments on commit 7c25680

Please sign in to comment.