1# termtree [![Main](https://github.com/rust-cli/termtree/actions/workflows/main.yml/badge.svg)](https://github.com/rust-cli/termtree/actions/workflows/main.yml)
2
3> Visualize tree-like data on the command-line
4
5[API documentation](https://docs.rs/termtree)
6
7## Example
8
9An example program is provided under the "examples" directory to mimic the `tree(1)`
10linux program
11
12```bash
13$ cargo run --example tree target
14    Finished debug [unoptimized + debuginfo] target(s) in 0.0 secs
15     Running `target/debug/examples/tree target`
16target
17└── debug
18    ├── .cargo-lock
19    ├── .fingerprint
20    |   └── termtree-21a5bdbd42e0b6da
21    |       ├── dep-example-tree
22    |       ├── dep-lib-termtree
23    |       ├── example-tree
24    |       ├── example-tree.json
25    |       ├── lib-termtree
26    |       └── lib-termtree.json
27    ├── build
28    ├── deps
29    |   └── libtermtree.rlib
30    ├── examples
31    |   ├── tree
32    |   └── tree.dSYM
33    |       └── Contents
34    |           ├── Info.plist
35    |           └── Resources
36    |               └── DWARF
37    |                   └── tree
38    ├── libtermtree.rlib
39    └── native
40```
41
42## Related Crates
43
44- [`treeline`](https://crates.io/crates/treeline): termtree was forked from this.
45- [`tree_decorator`](https://crates.io/crates/tree_decorator)
46- [`xtree`](https://crates.io/crates/xtree)
47- [`ptree`](https://crates.io/crates/ptree)
48
49## License
50
51Licensed under MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
52