https://github.com/jjotaum/groot
A command like tool to generate Tree representation from a given directory path
https://github.com/jjotaum/groot
command-line-tool generator macos swift tree-structure
Last synced: about 2 months ago
JSON representation
A command like tool to generate Tree representation from a given directory path
- Host: GitHub
- URL: https://github.com/jjotaum/groot
- Owner: jjotaum
- License: mit
- Created: 2023-11-11T15:17:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-16T11:20:48.000Z (2 months ago)
- Last Synced: 2025-04-25T11:16:31.460Z (about 2 months ago)
- Topics: command-line-tool, generator, macos, swift, tree-structure
- Language: Swift
- Homepage:
- Size: 15.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Groot
A command like tool to generate Tree representation from a given directory path
### Installation
Clone Groot on your machine:
```
$ git clone https://github.com/jjotaum/Groot.git
```
Navigate to it's directory:
```
$ cd Groot
```
Execute install script
Run install script using a directory as parameter e.g: /usr/local/bin
```
$ ./install.sh /usr/local/bin
```
Groot should now be installed on /usr/local/bin and can be accessed via terminal.
```
$ groot
```
### Usage
```
$ groot --help
USAGE: groot [--path ] [--depth ] [--hidden ]
OPTIONS:
-p, --path The directory path
-d, --depth The depth of the generated tree (default: 100)
-h, --hidden Defines if generated tree includes hidden files. (default: false)
-h, --help Show help information.
```
### Output Example
```
├── LICENSE
├── Package.resolved
├── Package.swift
├── README.md
├── Sources
│ ├── Groot
│ │ ├── Groot.swift
│ │ ├── TreeGenerator.swift
│ │ └── main.swift
├── Tests
│ ├── GrootTests
│ │ └── GrootTests.swift
└── install.sh
```