tree-fs 0.1.6 → 1.0.0

package/README.md

@@ -58,7 +58,22 @@ Generate structure from a text file saved in your repo.
 tree-fs structure.txt
 ```
 
-### 3. Programmatic API (For Tool Builders)
+### 3. Unix Piping (Stdin)
+
+You can pipe tree content directly into `tree-fs`. Perfect for automation or clipboard tools.
+
+```bash
+# Pipe from a file
+cat structure.txt | tree-fs
+
+# Pipe from clipboard (macOS)
+pbpaste | tree-fs
+
+# Echo directly
+echo "src/\n  index.js" | tree-fs
+```
+
+### 4. Programmatic API (For Tool Builders)
 
 Embed `tree-fs` into your own CLIs, generators, or scripts.
 
@@ -161,6 +176,17 @@ my-project
 
 **Note:** Internal emojis (logo_🔥.png) and filenames with parentheses (image(1).png) are preserved. We only strip "detached" decorations separated by spaces.
 
+## 🤖 The AI Workflow
+
+To get the perfect output from ChatGPT, Claude, or DeepSeek, add this to your system prompt or custom instructions:
+
+> "When asked to generate project directory structures, output them as a plain text tree diagram. Do not use code blocks for creation commands."
+
+Then simply copy the output and run:
+```bash
+npx tree-fs
+```
+
 ## 📦 CI/CD Integration
 
 You can use `tree-fs` to scaffold environments in GitHub Actions or pipelines.
@@ -177,4 +203,4 @@ tree-fs structure.txt --dry-run
 
 ## License
 
-MIT
+MIT

package/bin/tree-fs.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 
 const fs = require("fs")
-const path = require("path")
 const readline = require("readline")
 const { parseTree, generateFS } = require("../src")
 const pkg = require("../package.json")
 
 const args = process.argv.slice(2)
 
-// Standard Flags
+// --- Flag Handling ---
 if (args.includes("--version") || args.includes("-v")) {
   console.log(pkg.version)
   process.exit(0)
@@ -21,8 +20,8 @@ if (args.includes("--help") || args.includes("-h")) {
   Generate a real file system from a text-based directory tree.
 
   Arguments:
-    file           Text file containing the tree (optional)
-                   If ignored, tree-fs runs in interactive mode.
+    file           Text file containing the tree.
+                   If ignored, reads from STDIN or Interactive Mode.
 
   Options:
     -h, --help     Show this help message
@@ -31,14 +30,30 @@ if (args.includes("--help") || args.includes("-h")) {
 
   Examples:
     npx tree-fs                    # Interactive mode
-    npx tree-fs structure.txt      # Generate from file
-    npx tree-fs doc.md --dry-run   # Preview changes
+    npx tree-fs structure.txt      # From file
+    cat tree.txt | npx tree-fs     # From pipe
 `)
   process.exit(0)
 }
 
 const dryRun = args.includes("--dry-run")
 
+// --- Helper: Read from Piped Stdin (Non-Interactive) ---
+async function readPipedInput() {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: false
+  })
+
+  const lines = []
+  for await (const line of rl) {
+    lines.push(line)
+  }
+  return lines.join("\n")
+}
+
+// --- Helper: Read from Interactive Prompt ---
 async function readInteractiveInput() {
   console.log("Paste directory tree. Press Enter on an empty line to finish.\n")
 
@@ -49,7 +64,6 @@ async function readInteractiveInput() {
   })
 
   const lines = []
-
   for await (const line of rl) {
     if (line.trim() === "") {
       rl.close()
@@ -57,26 +71,27 @@ async function readInteractiveInput() {
     }
     lines.push(line)
   }
-
   return lines.join("\n")
 }
 
 async function main() {
   let input = ""
-
-  // 1. Check for file input (Any arg that isn't a flag)
   const fileArg = args.find(arg => !arg.startsWith("-"))
 
+  // 1. File Argument Provided
   if (fileArg) {
     try {
       input = fs.readFileSync(fileArg, "utf8")
     } catch (err) {
       console.error(`Error reading file: ${fileArg}`)
-      console.error(err.message)
       process.exit(1)
     }
   } 
-  // 2. Interactive Mode
+  // 2. Piped Input (Unix Style)
+  else if (!process.stdin.isTTY) {
+    input = await readPipedInput()
+  }
+  // 3. Interactive Mode (Human)
   else {
     input = await readInteractiveInput()
   }
@@ -90,9 +105,10 @@ async function main() {
     const tree = parseTree(input)
     generateFS(tree, process.cwd(), { dryRun })
 
+    // Minimal feedback for pipes/dry-run, success message for humans
     if (dryRun) {
       console.log("Dry run complete. No files written.")
-    } else {
+    } else if (process.stdin.isTTY) {
       console.log("✅ Structure created successfully.")
     }
   } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tree-fs",
-  "version": "0.1.6",
+  "version": "1.0.0",
   "description": "Generate file system structures from text-based directory trees. The standard receiver for AI-generated project scaffolding.",
   "bin": {
     "tree-fs": "bin/tree-fs.js"
@@ -13,17 +13,10 @@
     "README.md",
     "LICENSE"
   ],
-  "engines": {
-    "node": ">=14.0.0"
-  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 0",
     "start": "node bin/tree-fs.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mgks/tree-fs.git"
-  },
   "keywords": [
     "filesystem",
     "scaffold",
@@ -33,12 +26,26 @@
     "llm",
     "ai",
     "automation",
-    "cli"
+    "cli",
+    "fs",
+    "mkdir",
+    "unix"
   ],
-  "author": "Ghazi <hello@mgks.dev> (https://mgks.dev)",
-  "license": "MIT",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "author": {
+    "name": "mgks",
+    "url": "https://mgks.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mgks/tree-fs.git"
+  },
   "bugs": {
     "url": "https://github.com/mgks/tree-fs/issues"
   },
-  "homepage": "https://github.com/mgks/tree-fs#readme"
+  "homepage": "https://github.com/mgks/tree-fs#readme",
+  "funding": "https://github.com/sponsors/mgks",
+  "license": "MIT"
 }