Metadata-Version: 2.1
Name: printdirtree
Version: 0.1.4
Summary: A CLI utility to print the directory tree structure with customizable exclusions.
Home-page: https://github.com/timf34/PrintDirTree
Author: Tim Farrelly
Author-email: timf34@gmail.com
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyperclip

# PrintDirTree

`printdirtree` is a command-line utility that prints the structure of a directory tree, 
allowing you to easily specify files and directories to exclude. 

**Example:**

```bash
$ printdirtree
PrintDirTree
├── MANIFEST.in
├── README.md
├── printdirtree
│   ├── __init__.py
│   └── __main__.py
└── setup.py
```

This tool is very useful to aid with prompting ChatGPT. 

## Installation

Install `printdirtree` easily with pip:

```sh
pip install printdirtree
```

## Usage

To use `printdirtree`, simply run the command followed by optional arguments to tailor the output to your needs. 
The basic usage prints the current directory structure:

```sh
printdirtree
```

### Specifying a Directory

To print the structure of a specific directory:

```sh
printdirtree --dir /path/to/directory
```

### Excluding Directories and Files

Exclude specific directories and/or file patterns:

```sh
printdirtree --exclude-dir node_modules --exclude-dir .git --exclude-file "*.log"
```

### Saving Preferences

To save your exclusions for future runs:

```sh
printdirtree --exclude-dir temp --exclude-file "*.tmp" --save
```

### Viewing Current Exclusions

See what exclusions are currently saved:

```sh
printdirtree --view-exclusions
```

### Including Directories and Files Back

To remove exclusions and include directories or files back into the printout:

```sh
printdirtree --include-dir temp --include-file "*.tmp" --save
```

## Example Usage

After installing `printdirtree`, you can run it to visualize the structure of your project directory. Here's an example command that excludes `.git` files:

```sh
printdirtree --exclude-file ".git"
```

Output for the `PrintDirTree` project might look like this:

```
PrintDirTree
├── MANIFEST.in
├── README.md
├── printdirtree
│   ├── __init__.py
│   └── __main__.py
└── setup.py
```
