@the-agenticflow/openflows 0.1.1 → 0.1.3

package/README.md

@@ -0,0 +1,174 @@
+# @the-agenticflow/openflows npm Package
+
+## Installation
+
+```bash
+# Install globally
+npm install -g @the-agenticflow/openflows
+
+# Or use with npx (no install needed)
+npx @the-agenticflow/openflows setup
+```
+
+## What Gets Installed
+
+The post-install script (`scripts/install.js`) downloads platform-specific binaries from GitHub Releases:
+
+1. **Detects Platform**
+   - macOS: `x86_64-apple-darwin` or `aarch64-apple-darwin`
+   - Linux: `x86_64-unknown-linux-gnu/musl` or `aarch64-unknown-linux-gnu`
+
+2. **Downloads Binary**
+   - Fetches latest release from GitHub API
+   - Falls back to `v0.1.3` if API unavailable
+   - Downloads tarball containing:
+     - `agentflow` - Main orchestration binary
+     - `agentflow-setup` - Interactive TUI setup wizard
+     - `agentflow-dashboard` - Real-time monitoring TUI
+     - `agentflow-doctor` - System diagnostics tool
+     - `orchestration/` - Agent configurations
+     - `LICENSE` - MIT License
+
+3. **Extracts to Package**
+   - Extracts to `bin/` directory
+   - Renames binaries to `*-bin` for Node.js wrappers
+   - Sets executable permissions
+
+## Commands Available
+
+```bash
+openflows              # Start orchestration
+openflows-setup        # Run setup wizard
+openflows-dashboard    # Launch monitoring TUI
+openflows-doctor       # Run diagnostics
+```
+
+## Troubleshooting
+
+### Permission Denied (sudo install)
+
+**Problem**: `EACCES: permission denied, open '/tmp/openflows-...'`
+
+**Solution**: Fixed in v0.1.3 - install script now uses package-local `.tmp` directory instead of `/tmp`.
+
+**Workaround for older versions**:
+```bash
+# Install without sudo
+mkdir -p ~/.npm-global
+npm config set prefix '~/.npm-global'
+echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
+source ~/.bashrc
+npm install -g @the-agenticflow/openflows
+```
+
+### Network Issues (DNS/API failures)
+
+**Problem**: `getaddrinfo EAI_AGAIN api.github.com` or `undefined` in filename
+
+**Solution**: Fixed in v0.1.3 - script now:
+- Has timeout handling for GitHub API
+- Falls back to known version `v0.1.3` if API fails
+- Validates API response before using
+
+**Manual fix**:
+```bash
+# Build from source instead
+git clone https://github.com/The-AgenticFlow/OpenFlows.git
+cd OpenFlows
+cargo build --release --bin agentflow-setup
+sudo cp target/release/agentflow-setup /usr/local/bin/
+```
+
+### Binary Not Found
+
+**Problem**: Command not found after install
+
+**Solution**: Ensure `npm bin -g` is in your PATH
+```bash
+# Check where global bins are installed
+npm bin -g
+
+# Add to PATH if needed
+echo 'export PATH="$(npm bin -g):$PATH"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+## Publishing New Versions
+
+When a new GitHub release is created:
+
+1. **Update package.json version**:
+   ```bash
+   cd packaging/npm
+   # Edit package.json: "version": "0.1.4"
+   ```
+
+2. **Update fallback version in install.js**:
+   ```javascript
+   // Line 126
+   tag = 'v0.1.4'; // Update fallback
+   ```
+
+3. **Test locally**:
+   ```bash
+   npm pack
+   npm install -g the-agenticflow-openflows-0.1.4.tgz
+   openflows-setup --help
+   ```
+
+4. **Publish to npm**:
+   ```bash
+   npm publish --access public
+   ```
+
+## Files Included in npm Package
+
+```
+@the-agenticflow/openflows/
+├── package.json        # Package metadata
+├── README.md           # This file
+├── bin/
+│   ├── openflows.js           # Node.js wrapper
+│   ├── openflows-setup.js     # Node.js wrapper
+│   ├── openflows-dashboard.js # Node.js wrapper
+│   └── openflows-doctor.js    # Node.js wrapper
+└── scripts/
+    └── install.js      # Post-install binary downloader
+```
+
+## Technical Details
+
+### Platform Detection Logic
+
+```javascript
+// OS detection
+darwin  → apple-darwin
+linux   → unknown-linux-gnu OR unknown-linux-musl
+
+// Architecture detection
+x64   → x86_64
+arm64 → aarch64
+
+// Musl detection (Linux only)
+ldd --version | grep -q musl → use musl variant
+```
+
+### Fallback Chain
+
+1. Try GitHub API for latest release
+2. If API fails → use hardcoded `v0.1.3`
+3. Download `gnu` variant
+4. If `gnu` fails on x86_64 Linux → try `musl` variant
+5. Extract and install
+
+### Binary Wrappers
+
+Each command (`openflows`, `openflows-setup`, etc.) is a Node.js wrapper that:
+- Calls the downloaded binary (`*-bin`)
+- Passes through all arguments
+- Inherits stdio for interactive TUI
+- Exits with binary's exit code
+
+## License
+
+MIT - see LICENSE file in downloaded tarball or GitHub repository.

package/bin/openflows-dashboard.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const { spawn } = require('child_process');
 const path = require('path');
-const binaryPath = path.join(__dirname, '..', 'bin', 'openflows-dashboard-bin');
+const binaryPath = path.join(__dirname, '..', 'bin', 'agentflow-dashboard-bin');
 const proc = spawn(binaryPath, process.argv.slice(2), { stdio: 'inherit' });
 proc.on('exit', (code) => process.exit(code));

package/bin/openflows-setup.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const { spawn } = require('child_process');
 const path = require('path');
-const binaryPath = path.join(__dirname, '..', 'bin', 'openflows-setup-bin');
+const binaryPath = path.join(__dirname, '..', 'bin', 'agentflow-setup-bin');
 const proc = spawn(binaryPath, process.argv.slice(2), { stdio: 'inherit' });
 proc.on('exit', (code) => process.exit(code));

package/bin/openflows.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const { spawn } = require('child_process');
 const path = require('path');
-const binaryPath = path.join(__dirname, '..', 'bin', 'openflows-bin');
+const binaryPath = path.join(__dirname, '..', 'bin', 'agentflow-bin');
 const proc = spawn(binaryPath, process.argv.slice(2), { stdio: 'inherit' });
 proc.on('exit', (code) => process.exit(code));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-agenticflow/openflows",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Autonomous AI development team — turns GitHub issues into working PRs",
   "main": "index.js",
   "bin": {
@@ -16,18 +16,35 @@
     "type": "git",
     "url": "git+https://github.com/The-AgenticFlow/AgentFlow.git"
   },
-  "keywords": ["ai", "autonomous", "development", "agents", "github"],
+  "keywords": [
+    "ai",
+    "autonomous",
+    "development",
+    "agents",
+    "github"
+  ],
   "author": "The AgenticFlow Team",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/The-AgenticFlow/AgentFlow/issues"
   },
   "homepage": "https://openflows.dev",
+  "files": [
+    "bin/",
+    "scripts/",
+    "README.md"
+  ],
   "engines": {
     "node": ">=18.0.0"
   },
-  "os": ["darwin", "linux"],
-  "cpu": ["x64", "arm64"],
+  "os": [
+    "darwin",
+    "linux"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
   "optionalDependencies": {
     "@openflows/linux-x64-gnu": "0.1.0",
     "@openflows/linux-x64-musl": "0.1.0",

package/scripts/install.js

@@ -101,27 +101,55 @@ async function main() {
         fs.mkdirSync(BIN_DIR, { recursive: true });
     }
 
-    // Get latest release tag
-    const tag = await new Promise((resolve, reject) => {
-        https.get(`https://api.github.com/repos/${REPO}/releases/latest`, {
-            headers: { 'User-Agent': 'openflows-npm-installer' }
-        }, (res) => {
-            let data = '';
-            res.on('data', (chunk) => data += chunk);
-            res.on('end', () => {
-                try {
-                    const json = JSON.parse(data);
-                    resolve(json.tag_name);
-                } catch {
-                    reject(new Error('Failed to parse release info'));
+    // Get latest release tag with better error handling
+    let tag;
+    try {
+        tag = await new Promise((resolve, reject) => {
+            const req = https.get(`https://api.github.com/repos/${REPO}/releases/latest`, {
+                headers: { 
+                    'User-Agent': 'openflows-npm-installer',
+                    'Accept': 'application/vnd.github.v3+json'
+                }
+            }, (res) => {
+                if (res.statusCode !== 200) {
+                    reject(new Error(`GitHub API returned ${res.statusCode}`));
+                    return;
                 }
+                let data = '';
+                res.on('data', (chunk) => data += chunk);
+                res.on('end', () => {
+                    try {
+                        const json = JSON.parse(data);
+                        if (!json.tag_name) {
+                            reject(new Error('No tag_name in release response'));
+                        } else {
+                            resolve(json.tag_name);
+                        }
+                    } catch (parseErr) {
+                        reject(new Error(`Failed to parse release info: ${parseErr.message}`));
+                    }
+                });
             });
-        }).on('error', reject);
-    });
+            req.on('error', reject);
+            req.setTimeout(30000, () => {
+                req.destroy();
+                reject(new Error('GitHub API request timeout'));
+            });
+        });
+    } catch (apiErr) {
+        console.error(`[@the-agenticflow/openflows] GitHub API error: ${apiErr.message}`);
+        console.error('[@the-agenticflow/openflows] Falling back to latest known version: v0.1.3');
+        tag = 'v0.1.3';
+    }
 
     const archiveName = `openflows-${tag}-${platform}.tar.gz`;
     const downloadUrl = `https://github.com/${REPO}/releases/download/${tag}/${archiveName}`;
-    const tmpFile = path.join(os.tmpdir(), archiveName);
+    // Use package's temp directory instead of system /tmp to avoid permission issues
+    const tmpDir = path.join(__dirname, '..', '.tmp');
+    if (!fs.existsSync(tmpDir)) {
+        fs.mkdirSync(tmpDir, { recursive: true });
+    }
+    const tmpFile = path.join(tmpDir, archiveName);
 
     try {
         await download(downloadUrl, tmpFile);
@@ -131,7 +159,7 @@ async function main() {
         if (platform === 'x86_64-unknown-linux-gnu') {
             const muslArchiveName = `openflows-${tag}-x86_64-unknown-linux-musl.tar.gz`;
             const muslDownloadUrl = `https://github.com/${REPO}/releases/download/${tag}/${muslArchiveName}`;
-            const muslTmpFile = path.join(os.tmpdir(), muslArchiveName);
+            const muslTmpFile = path.join(tmpDir, muslArchiveName);
             console.log(`[@the-agenticflow/openflows] Trying musl fallback...`);
             await download(muslDownloadUrl, muslTmpFile);
             await extractTarGz(muslTmpFile, BIN_DIR);
@@ -155,6 +183,14 @@ async function main() {
     if (fs.existsSync(tmpFile)) {
         fs.unlinkSync(tmpFile);
     }
+    // Clean up temp directory if empty
+    try {
+        if (fs.existsSync(tmpDir) && fs.readdirSync(tmpDir).length === 0) {
+            fs.rmdirSync(tmpDir);
+        }
+    } catch (cleanupErr) {
+        // Ignore cleanup errors
+    }
     console.log(`[openflows] Installation complete!`);
 }