A command-line tool to generate a tree structure of a folder and its contents, useful for when you need to add context to your GPT prompts.
Project description
Tree Maker CLI
A command-line tool to generate a tree structure of a folder and its contents, useful for when you need to add context to your GPT prompts.
Features
- Generates a visual representation of a directory's structure
- Supports customizable depth limiting
- Allows excluding specific files and directories
- Provides options to include or exclude hidden files
- Output can be saved to a file or copied to the clipboard
Usage
Installation
Install via pip
:
pip install tree-maker-cli
Using this tool
Once installed, you can call the tool with the command
tree-maker [options] [directory]
If called without arguments, it will print the tree structure from the current folder. If called with a valid folder path, it will print the tree structure from that location.
tree-maker /path/to/folder
Arguments
The following arguments are available:
--depth
: Sets the depth of the tree structure to print--clipboard
(or-c
): Copy the tree to the clipboard--output
(or-o
): Set the output file path--exclude
: Files and/or folders to exclude from the tree--show-hidden
: Show hidden files in the tree structure
For example, to print a tree of depth two with hidden files and excluding the folders public
, tmp
, and log
and then copy it to the clipboard:
tree-maker --depth=2 -c --show-hidden /path/to/your/app --exclude public tmp log
To save to a text file:
tree-maker [arguments] --output path/to/output.txt
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tree_maker_cli-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de53bdb2c34e70cc833beae70fee6b5966acebe25f879e02c03ab68bfd5656fc |
|
MD5 | b418dcdae01afd93c325b0278160d25f |
|
BLAKE2b-256 | c7e08c5d09f8ae0d88541ec85c92e68cbe997b95016adf40e5ccad0f0f927799 |