pathy 1.0.1

A CLI tool to display the file tree of a directory
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# [pathy](https://github.com/fearandesire/pathy) 🦀

Minimal Rust CLI tool to display directory structures

![version badge](https://img.shields.io/crates/v/pathy?labelColor=%23e77823&color=%23002fff
)
![maintenance status badge: as-is](https://badgen.net/static/status/as-is/orange)
---
![pathy example screenshot](https://i.imgur.com/pkDS7bw.png)
## Features

- 🧠 **Smart Display**: Automatically excludes commonly [ignored directories](src/config.rs) (e.g `.git` and `node_modules`) for a cleaner tree visualization.
- 👨‍🦯 **Easy Exclusions**: Use the `-i` option to seamlessly omit any specific directories & files from the display.
## Install
### via Cargo
```sh
cargo install pathy

```
### via Source
```sh
git clone https://github.com/fearandesire/pathy.git

cd pathy

cargo build --release

cargo install .

```

# Usage

Basic usage: `pathy <directory>`
## Arguments

- `<directory>`: Directory to display. _Defaults to the current directory._
- `-i`, or `--ignore`: Specify directories or files to ignore`
- `-h`, or `--help`: Display this help message
- `-v`, or `--version`: Display the current version
## Default Ignored Directories
You can review the default ignored directories [here](src/config.rs)
## Examples
```sh
pathy .
# Ignoring a directory
pathy -i docs
# Ignoring multiple directories
pathy -i docs node_modules .
# Ignore a directory and a any file 
pathy -i docs README.md
```
> **Notice:** Ignoring a directory / a file will explicitly exclude any exact match. E.g, ignoring `-i README.md` will ignore `README.md` from the file tree visualization entirely, no matter how far down it is.

## Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues to improve the functionality or documentation of pathy.

## License


This project is licensed under the MIT License - see the LICENSE file for details.

## Author

- [fenix](https://github.com/fearandesire)