Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterbenoit/tree-shaker
Create file system structures from ASCII tree diagrams with style! tree-shaker is a Deno-powered CLI tool that transforms text-based directory trees into real file system structures.
https://github.com/peterbenoit/tree-shaker
automation cli deno developer-tools directory-generator file-system filesystem-utility tree-structure typescript
Last synced: about 2 months ago
JSON representation
Create file system structures from ASCII tree diagrams with style! tree-shaker is a Deno-powered CLI tool that transforms text-based directory trees into real file system structures.
- Host: GitHub
- URL: https://github.com/peterbenoit/tree-shaker
- Owner: peterbenoit
- Created: 2024-11-18T19:19:52.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T20:41:35.000Z (about 2 months ago)
- Last Synced: 2024-11-18T20:53:48.184Z (about 2 months ago)
- Topics: automation, cli, deno, developer-tools, directory-generator, file-system, filesystem-utility, tree-structure, typescript
- Language: TypeScript
- Homepage:
- Size: 214 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌳 tree-shaker
[](https://deno.land)
[](LICENSE)
Create file system structures from ASCII tree diagrams with style! tree-shaker
is a Deno-powered CLI tool that transforms text-based directory trees into real
file system structures.
## 🚀 Features
- Convert ASCII tree diagrams into real directories and files
- Smart depth detection for nested structures
- Command-line interface with customizable input/output paths
- Zero dependencies (besides Deno standard library)
- Simple and lightweight
## 📦 Installation
### Option 1: Install from URL
```bash
# Install directly from GitHub
deno install --allow-read --allow-write https://raw.githubusercontent.com/peterbenoit/tree-shaker/main/super-shake.ts
```
### Option 2: Clone and Run
# Clone the repository
```
git clone https://github.com/peterbenoit/tree-shaker.git
```
# Change directory
```
cd tree-shaker
```
# Run directly
```
deno run --allow-read --allow-write super-shake.ts --input=./examples/tree.txt --output=./my-project
```
### Option 3: Download Binary
Download the latest release from our releases page.
# Make executable (macOS/Linux)
```
chmod +x tree-shaker
```
# Add to your PATH
```
mv tree-shaker /usr/local/bin/
```
## 📦 Releases
Download the latest binary for your platform:
https://github.com/peterbenoit/tree-shaker/releases
## ⚠️ Disclaimer
**USE AT YOUR OWN RISK**
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
By using tree-shaker you acknowledge:
- This is experimental software
- Files and directories will be created on your system
- No responsibility is taken for lost or damaged files
- Always verify generated directory structures
- Back up important data before use
- Use in production environments at your own risk
### 📝 Example Usage
Create a tree file (tree.txt):
```
my-project/
├── src/
│ ├── main.ts
│ └── utils/
│ └── helper.ts
├── tests/
│ └── main.test.ts
└── README.md
```
Run tree-shaker:
```
tree-shaker --input=tree.txt --output=./my-project
```
### 🤝 Contributing
1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request
📄 License MIT © [Peter Benoit](https://www.peterbenoit.com)