dic-structure-creater 0.1.0

A CLI tool that reads tree-structured text files and generates folders and files accordingly.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# DicStructureCreater


![Release](https://img.shields.io/github/v/release/natsuki221/DicStructureCreater)
![License](https://img.shields.io/badge/license-MIT-blue)
![Stars](https://img.shields.io/github/stars/natsuki221/DicStructureCreater)

DicStructureCreater is a lightweight, cross-platform CLI tool that parses directory structures from `.txt` or `.md` files and generates corresponding folders and files under a specified root directory. By default, it avoids overwriting existing files, and supports dry-run (`--dry-run`) and force overwrite (`--overwrite`) modes.

---
## README

[zh_TW](/docs/README_zh_TW.md)

## Features


- 📁 **Automatic generation**: Generate folder structures and empty files from `tree` ASCII diagrams or Markdown-style lists.
- 🔒 **Safe by default**: Existing files won't be overwritten unless explicitly allowed.
- 🔄 **Optional overwrite**: Use `--overwrite` (`-O`) to force replace files.
- 👀 **Dry-run support**: Use `--dry-run` (`-d`) to preview actions without changing your file system.
- ⚙️ **Cross-platform**: Built with Rust, compatible with Windows, macOS, and Linux.

---

## Installation


### Using Cargo

```bash
cargo install dic-structure-creater
```

### Download Precompiled Binary

1. Visit the Releases page:  
   https://github.com/natsuki221/DicStructureCreater/releases
2. Download the archive for your OS, extract it, and place `dsc` (or `dsc.exe`) in your system's `PATH`.

---

## Example Usage


Given a structure file `structure.txt`:
```txt
src/
├── lib/
│   └── utils.rs
└── main.rs
```

1. **Preview only** (dry-run):
```bash
dsc structure.txt --dry-run

```

2. **Generate structure** (without overwriting existing files):
```bash
dsc structure.txt

```

3. **Force overwrite existing files**:
```bash
dsc structure.txt --overwrite

```

---

## CLI Options


| Option                   | Description                                        |
|--------------------------|----------------------------------------------------|
| `STRUCTURE_FILE`         | Path to the input structure file (required)        |
| `-r, --root <path>`      | Root directory to create files/folders (default: `.`) |
| `-O, --overwrite`        | Overwrite existing files                           |
| `-d, --dry-run`          | Show actions without making changes                |
| `-h, --help`             | Display help message                               |

---

## Supported Input Formats


DSC supports two main formats:

1. **Tree ASCII format**:
```txt
src/
├── models/
│   └── user.rs
└── main.rs
```

2. **Markdown list format**:
```md
- src
  - models
    - user.rs
  - main.rs
```

> **Note**: Lines ending with `/` are treated as folders; otherwise, they are considered files.

---

## Contributing


Contributions are welcome! You can submit Issues, Pull Requests, suggestions, or bug reports.

Steps:
1. Fork this repository
2. Create a new branch (`git checkout -b feature/your-feature`)
3. Implement your changes
4. Submit a Pull Request

---

## License


This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

---

> For questions, feel free to open an issue or discussion. Happy hacking! 🚀