Skip to content

Grolleau-Benjamin/arbor

🌴 Arbor — The Smart Tree

by Benjamin Grolleau & Angelo Tunney

Arbor Logo

Rust Status Version

Arbor is a modern and smart reimplementation of the traditional tree command. Its goal is to provide developers with a more intuitive and visually clear way to explore project structures. Unlike the classic version, Arbor introduces several improvements such as configurable depth levels for better readability, colorized output and added icons to distinguish files and directories at a glance, and automatic filtering of files or folders ignored by Git (based on the .gitignore file). It can also display the Git status of files, showing whether they are untracked, modified, staged for commit, or stashed. Arbor is written in Rust.

Screen

🚀 Quick start

curl -fsSLO https://raw.githubusercontent.com/Grolleau-Benjamin/arbor/main/install.sh
curl -fsSLO https://raw.githubusercontent.com/Grolleau-Benjamin/arbor/main/install.sh.sha256
sha256sum -c install.sh.sha256 && bash install.sh

Then run:

arbor -d 2 -c always -i
# equivalent to
arbor --depth 2 --color always --icons

🔐 Security

The installation checksum file (install.sh.sha256) is GPG-signed, and the project owner’s public key is available for verification. You can verify the signature using the following commands:

curl -fsSLO https://raw.githubusercontent.com/Grolleau-Benjamin/arbor/main/install.sh.sha256.sig
curl -fsSLO https://raw.githubusercontent.com/Grolleau-Benjamin/arbor/main/public-key.asc
gpg --import public-key.asc
gpg --verify install.sh.sha256.sig install.sh.sha256

# You should see :
# gpg: Good signature from "Benjamin Grolleau (Arbor) <...>"

📘 Documentation

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to open a pull request.

👥 Contributors

Benjamin Grolleau
Benjamin Grolleau
Angelo Tunney
Angelo Tunney

📜 License

Licensed under the Apache-2.0 License. See LICENSE for more information.

About

Arbor is a modern and smart reimplementation of the traditional tree command. Its goal is to provide developers with a more intuitive and visually clear way to explore project structures.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors