Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,63 @@ node dist/cli.js --root . --infer-root --gitkeep --from tree.txt
cat tree.txt | node dist/cli.js --root . --infer-root
```

### Run modes

#### 1) Global (installed from npm)

After `npm i -g structforge`:

```bash
# Linux/macOS
structforge --root /tmp/out --infer-root --from ./tree.txt
# or piping inline text
cat <<'EOF' | structforge --root /tmp/out --infer-root --verbose
my-app/
src/
index.ts
package.json
EOF
```

```powershell
# Windows PowerShell
structforge --root "D:\out" --infer-root --from .\tree.txt
@"
my-app/
src/
index.ts
package.json
"@ | structforge --root "D:\out" --infer-root --verbose
```

#### 2) Local (using the built dist of this repo)

```bash
pnpm i && pnpm build
node dist/cli.js --root /tmp/out --infer-root --from ./tree.txt
# or
cat tree.txt | node dist/cli.js --root /tmp/out --infer-root
```

#### 3) Dev (ts-node, without building)

```bash
pnpm i
pnpm dev -- --root /tmp/out --infer-root --from ./tree.txt
# or
cat tree.txt | pnpm dev -- --root /tmp/out --infer-root
```

Tips:

* Preview first:

```bash
structforge --root /tmp/out --infer-root --dry-run --from ./tree.txt
```
* Create placeholders for empty dirs: add `--gitkeep`.
* Increase logs: add `--verbose`.

### Input rules (read carefully)

* **Do not add comments or annotations** in the structure. Only list directories and files.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "structforge",
"version": "1.0.1",
"version": "1.0.2",
"description": "Text-to-filesystem scaffolder that understands ASCII trees, indented lists, and path lines. Safe, zero runtime deps.",
"type": "module",
"bin": {
Expand Down