scaffdir/README.md

Generate folders and files from a simple tree

# scaffdir

📁 **scaffdir** is a command-line tool that generates folders and files from a simple text-based tree structure. It's perfect for scaffolding project directories or quickly mocking up file structures.

---


## ✨ Features

- 📂 Create nested folders and files from a `.txt` file
- 💡 Supports dry-run mode to preview what will be created
- 💬 Friendly output with emoji and color (uses `chalk`)
- 🧠 Smart parsing of indentation-based tree structures
- 🔗 Easily installable as a global CLI tool

---


## 🚀 Installation

You can install `scaffdir` globally using npm:

```bash
npm install -g scaffdir
```

## 🛠️ Usage

The tool accepts the following flags

- 📄 `-f --file <file>` (Required) Path to the input file describing the folder/file tree structure.
- 📂 `-o --output <dir>` Output directory where structure should be created (defaults to current dir)
- 🧪 `-d, --dry-run` Show what would be created without making any changes on disk.
- `-V, --version` Display the current version
- `-h, --help` Show help message

Use the flags together like below:

```bash
scaffdir -f <structure.txt> [-o <output-directory>] [--dry-run]

```

## 📄 Example Input File

Here's an example of what the input text file might look like

```bash
my-app/
  index.html
  src/
    main.js
    utils.js
  styles/
    main.css
  README.md
```

Use 2 spaces for indentation. Folder names should end with a `/`

## ✅ Example Usage

### 🧪 Dry Run

```bash
scaffdir -f structure.txt --dry-run
```

### Output

```bash
📂 Reading structure from: structure.txt...
📂 Output directory: /your/current/dir
📁 Would create folder: /your/current/dir/my-app
📄 Would create file: /your/current/dir/my-app/index.html
📁 Would create folder: /your/current/dir/my-app/src
📄 Would create file: /your/current/dir/my-app/src/main.js
📄 Would create file: /your/current/dir/my-app/src/utils.js
📁 Would create folder: /your/current/dir/my-app/styles
📄 Would create file: /your/current/dir/my-app/styles/main.css
📄 Would create file: /your/current/dir/my-app/README.md
```

## 🛠 Create Structure

```bash
scaffdir -f structure.txt -o ./generated-project
```

## 📝 License

MIT License © Damain Gabriel