https://github.com/emmo00/treee

command-line utility that generates a visual representation of a directory structure
https://github.com/emmo00/treee

Last synced: about 15 hours ago
JSON representation

command-line utility that generates a visual representation of a directory structure

• Host: GitHub
• URL: https://github.com/emmo00/treee
• Owner: Emmo00
• Created: 2024-09-14T08:17:32.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-15T20:05:00.000Z (4 months ago)
• Last Synced: 2024-09-15T21:59:45.310Z (4 months ago)
• Language: C
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# treee

This project is a simple command-line utility that generates a visual representation of a directory structure, similar to the `tree` command in Unix-based systems. It traverses a given directory path and prints the names of files and directories in a tree-like format.

## Usage

To use the program clone the repo, then `cd` into the project directory. Compile and run it from the command line:

```bash

make

./build/bin/treee 

```

### Command-Line Arguments:

- ``: The path of the directory to traverse.

- `--help` or `-h`: Displays usage instructions.

### Example:

```bash

$ ./build/bin/treee .

./

├── src/

│   └── main.c

│   └── utils.c

├── include/

│   └── utils.h

├── build/

│   ├── obj/

│   │   └── utils.o

│   │   └── main.o

│   ├── bin/

│   │   └── treee

├── .vscode/

│   └── settings.json

└── Makefile

└── .gitignore

└── README.md

```

## License

This project is open-source and available under the MIT License.