tree2fs-rs
| Crates.io | tree2fs-rs |
| lib.rs | tree2fs-rs |
| version | 0.1.0 |
| created_at | 2025-11-26 15:37:16.459939+00 |
| updated_at | 2025-11-26 15:37:16.459939+00 |
| description | Convert tree-formatted text into filesystem structures. |
| homepage | |
| repository | https://github.com/fasilmveloor/tree2fs-rs |
| max_upload_size | |
| id | 1951568 |
| size | 42,983 |
fasilmveloor (fasilmveloor)
documentation
README
tree2fs-rs 🦀
tree2fs-rs is a blazing fast command-line tool written in Rust that converts tree-formatted text into actual filesystem structures (directories and files).
It is the Rust port of the original Python tree2fs tool, offering improved performance, safety, and a single-binary distribution.
🚀 Features
- Simple Syntax: Uses standard tree output format (like the
treecommand). - Safe Preview: Dry-run mode (
--dry-run) lets you see exactly what will be created. - Flexible: Create structures in any target directory.
- Smart Parsing: Handles Unicode tree characters (
│,├,└,─) and indentation automatically. - Cross-Platform: Works on Linux, macOS, and Windows.
- Zero Dependencies: Distributed as a single static binary.
📦 Installation
Automated Install (Linux & macOS)
The easiest way to install is via our shell script:
curl -fsSL https://raw.githubusercontent.com/fasilmveloor/tree2fs-rs/main/install.sh | bash
From Crates.io
If you have Rust installed:
cargo install tree2fs-rs
From Source
git clone https://github.com/fasilmveloor/tree2fs-rs.git
cd tree2fs-rs
cargo install --path .
🛠️ Usage
1. Create a Tree File
Create a text file (e.g., structure.txt) describing your directory layout:
my-project/
├── src/
│ ├── main.rs
│ └── lib.rs
├── Cargo.toml
└── README.md
2. Generate Filesystem
Run the tool to create the structure:
tree2fs-rs structure.txt
Options
| Option | Description |
|---|---|
--dry-run |
Preview changes without creating any files. |
-v, --verbose |
Enable detailed logging of operations. |
-b, --base-dir <DIR> |
Specify the target directory (default: current dir). |
--no-skip-root |
Create the root directory itself (e.g., my-project/) instead of just its contents. |
Example:
# Preview creation in a specific folder
tree2fs-rs structure.txt --base-dir ./output --dry-run --verbose
📝 Input Format Rules
- Directories: Must end with a forward slash
/. - Files: Anything without a trailing slash.
- Comments: Lines starting with
#or text after#are treated as comments. - Indentation: Uses standard tree characters or spaces.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/amazing-feature). - Commit your changes (
git commit -m 'Add some amazing feature'). - Push to the branch (
git push origin feature/amazing-feature). - Open a Pull Request.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.