From e26db188d76c8a3f83b26dd450782e187767e065 Mon Sep 17 00:00:00 2001 From: mayconrfreitas Date: Mon, 29 Sep 2025 21:27:20 -0300 Subject: [PATCH 1/4] update README to add detailed usage instructions for global, local, and dev run modes --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/README.md b/README.md index bab481e..13ce62d 100644 --- a/README.md +++ b/README.md @@ -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. From 9c134fe67d95baafd0bfe26829957d56ebb086ed Mon Sep 17 00:00:00 2001 From: mayconrfreitas Date: Mon, 29 Sep 2025 21:27:41 -0300 Subject: [PATCH 2/4] chore(release): 1.0.2 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 68df3ec..cb9ab48 100644 --- a/package.json +++ b/package.json @@ -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": { From 3eae6c66ff9ea1b4f8fc4b7f936fc4dbb82212d0 Mon Sep 17 00:00:00 2001 From: mayconrfreitas Date: Mon, 29 Sep 2025 21:42:40 -0300 Subject: [PATCH 3/4] fix: correct indentation and formatting in example API structure --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 13ce62d..34ccdf2 100644 --- a/README.md +++ b/README.md @@ -121,9 +121,9 @@ Tips: example-api/ ├─ app/ │ ├─ main.py -│ ├─ core/ -│ │ ├─ settings.py -│ │ └─ logging.py +│ └─core/ +│ ├─ settings.py +│ └─ logging.py ├─ Dockerfile └─ README.md ``` @@ -134,16 +134,10 @@ example-api/ example-api/ ├─ app/ │ ├─ main.py -│ ├─ core/ -│ │ ├─ settings.py # global settings -│ │ └─ logging.py # any other comments -│ ├─ api/ -│ │ ├─ routers/ -│ │ │ ├─ users.py -│ │ └─ errors.py -│ └─ utils/ -│ └─ http.py -├─ Dockerfile # optional +│ └─core/ +│ ├─ settings.py # global settings +│ └─ logging.py ------> any other comments +├─ Dockerfile (optional) └─ README.md ``` From 03524e446e48742fd3885c0ed62c93691ac0a955 Mon Sep 17 00:00:00 2001 From: mayconrfreitas Date: Mon, 29 Sep 2025 21:42:47 -0300 Subject: [PATCH 4/4] chore(release): 1.0.3 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index cb9ab48..c0b21f0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "structforge", - "version": "1.0.2", + "version": "1.0.3", "description": "Text-to-filesystem scaffolder that understands ASCII trees, indented lists, and path lines. Safe, zero runtime deps.", "type": "module", "bin": {