treekt

treekt is a tree-like tool written in Kotlin.

The standard Windows' tree command lacks of configurability. The treee alternative did not convince me either.

So I started this one.

How to Install

Unzip to a directory of your choice and set the path to the bin directory.

You should also be able to use it from within a Gradle build (did not try this yet).

Usage

treekt's default: print the current directory and all its children recursively (as tree does).

However, you might need to tweak the output a bit. There are some options:

> treekt -h
Usage: treekt options_list
Options:
--depth, -l [256] -> number of levels (max. 256) { Int }
--dir, -d [<current dir>] -> directory { String }
--showFiles, -f [false] -> show files
--skip, -s [.*] -> skip pattern (works on directories and files) { String }
--skipDir, -sd -> skip directory pattern { String }
--skipFile, -sf -> skip file pattern { String }
--hideFiles, -hf [NONE] -> hide system files of type (not all starting with '.' are hidden files! \
             { Value should be one of [none, all_system_files, system_files_files_only, system_files_directories_only] }
--limitDirsTo, -ld [2147483647] -> limit the number of displayed directories { Int }
--limitFilesTo, -lf [2147483647] -> limit the number of displayed files { Int }
--out, -o -> output file { String }
--format [UTF8] -> output format { Value should be one of [ascii, utf8] }
--help, -h -> Usage info

Example 1

Ignore system files and directories as well as build and out directory and all settings. Show 3 levels. Output goes to out.txt:

treekt -f --depth 3 -hsf -hsd -sd build -sd out -s ".*settings.*" -o "out.txt" 

Output is something like:

<dir>\treekt
+---gradle
|   \---wrapper
|       gradle-wrapper.jar
|       gradle-wrapper.properties
+---treekt
|   \---src
|       +---main
|       \---test
|   build.gradle.kts
gradlew
gradlew.bat
README.md

Example 2

Sometimes the sheer number of directories obstructs the view of essential parts. In that case limit the displayed files.

The example lists 4 levels, limits to 3 directories and 2 files.

> treekt -f -l 4 -ld 3 -lf 2 -sd buildSrc 

Output is something like:

----
<dir>\treekt-dev
+---.git
|   +---hooks
|   |   applypatch-msg.sample
|   |   commit-msg.sample
|   |   ...
|   +---info
|   |   exclude
|   +---logs
|   |   \---refs
|   |       +---heads
|   |       \---remotes
|   |   HEAD
|   \---...
|   COMMIT_EDITMSG
|   config
|   ...
+---gradle
|   \---wrapper
|       gradle-wrapper.jar
|       gradle-wrapper.properties
+---treekt
|   \---src
|       +---main
|       |   +---kotlin
|       |   \---resources
|       \---test
|           +---kotlin
|           \---resources
|   build.gradle.kts
\---...
.gitattributes
.gitignore
...
----

What's next?

At the moment I am quite happy with it. It satisfies my personal requirements. However, there are still ideas:

• other output formats (e.g., non-ascii)
• try it from a Gradle build for auto-documentation