hypha-cli 0.1.3 → 0.1.4

package/README.md

@@ -10,23 +10,25 @@ npm install -g hypha-cli
 
 Requires **Node.js >= 22** (for native WebSocket support).
 
+> **Note:** The Python `hypha` package also installs a `hypha` command. If you have both installed, use `npx hypha-cli` to run the Node.js CLI without conflicts.
+
 ## Quick Start
 
 ```bash
 # Login (opens browser for OAuth)
-hypha login
+npx hypha-cli login
 
 # Check workspace info
-hypha info
+npx hypha-cli info
 
 # List services
-hypha services
+npx hypha-cli services
 
 # List artifacts
-hypha artifacts ls
+npx hypha-cli artifacts ls
 
 # Upload a file
-hypha artifacts cp ./data.csv my-model:data/train.csv
+npx hypha-cli artifacts cp ./data.csv my-model:data/train.csv
 ```
 
 ## Configuration
@@ -42,7 +44,7 @@ HYPHA_WORKSPACE=<your-workspace>
 You can also set these as environment variables, or use global flags:
 
 ```bash
-hypha --server https://hypha.aicell.io --workspace my-ws artifacts ls
+npx hypha-cli --server https://hypha.aicell.io --workspace my-ws artifacts ls
 ```
 
 ## Commands
@@ -50,10 +52,10 @@ hypha --server https://hypha.aicell.io --workspace my-ws artifacts ls
 ### Workspace Management
 
 ```bash
-hypha login [server-url]                    # OAuth login (opens browser)
-hypha token [--expires-in N] [--permission P] [--workspace W] [--json]
-hypha services [--type T] [--include-unlisted] [--json]
-hypha info [--json]
+npx hypha-cli login [server-url]                    # OAuth login (opens browser)
+npx hypha-cli token [--expires-in N] [--permission P] [--workspace W] [--json]
+npx hypha-cli services [--type T] [--include-unlisted] [--json]
+npx hypha-cli info [--json]
 ```
 
 ### Apps — Server App Lifecycle
@@ -61,14 +63,14 @@ hypha info [--json]
 Manage server app definitions (like Docker images) and running instances (like containers).
 
 ```bash
-hypha apps list [--json]                    # List installed app definitions
-hypha apps info <app-id> [--json]           # Show app details
-hypha apps install <source> [--id ID] [--manifest P] [--files D...] [--overwrite]
-hypha apps uninstall <app-id>               # Remove app definition
-hypha apps start <app-id> [--timeout N] [--wait]  # Start instance
-hypha apps stop <id> [--all]                # Stop instance(s)
-hypha apps ps [--json]                      # List running instances
-hypha apps logs <instance-id> [--tail N] [--type T]
+npx hypha-cli apps list [--json]                    # List installed app definitions
+npx hypha-cli apps info <app-id> [--json]           # Show app details
+npx hypha-cli apps install <source> [--id ID] [--manifest P] [--files D...] [--overwrite]
+npx hypha-cli apps uninstall <app-id>               # Remove app definition
+npx hypha-cli apps start <app-id> [--timeout N] [--wait]  # Start instance
+npx hypha-cli apps stop <id> [--all]                # Stop instance(s)
+npx hypha-cli apps ps [--json]                      # List running instances
+npx hypha-cli apps logs <instance-id> [--tail N] [--type T]
 ```
 
 **Aliases**: `ls` = `list`, `rm` = `uninstall`
@@ -80,36 +82,36 @@ hypha apps logs <instance-id> [--tail N] [--type T]
 Linux-style commands for managing artifacts (datasets, models, files). Artifact paths use `alias:path/to/file` notation.
 
 ```bash
-hypha artifacts ls [artifact[:path]] [--json] [--long]
-hypha artifacts cat <artifact:path>
-hypha artifacts cp <src> <dest> [-r] [--commit]
-hypha artifacts rm <artifact[:path]> [-r] [--force]
-hypha artifacts create <alias> [--type T] [--parent P]
-hypha artifacts info <artifact> [--json]
-hypha artifacts search <query> [--type T] [--limit N] [--json]
-hypha artifacts commit <artifact> [--version V] [--message M]
-hypha artifacts edit <artifact> [--name N] [--description D]
-hypha artifacts discard <artifact>
+npx hypha-cli artifacts ls [artifact[:path]] [--json] [--long]
+npx hypha-cli artifacts cat <artifact:path>
+npx hypha-cli artifacts cp <src> <dest> [-r] [--commit]
+npx hypha-cli artifacts rm <artifact[:path]> [-r] [--force]
+npx hypha-cli artifacts create <alias> [--type T] [--parent P]
+npx hypha-cli artifacts info <artifact> [--json]
+npx hypha-cli artifacts search <query> [--type T] [--limit N] [--json]
+npx hypha-cli artifacts commit <artifact> [--version V] [--message M]
+npx hypha-cli artifacts edit <artifact> [--name N] [--description D]
+npx hypha-cli artifacts discard <artifact>
 ```
 
 **Aliases**: `list` = `ls`, `mkdir` = `create`, `find` = `search`
 
-**Shorthand**: `hypha art` = `hypha artifacts`
+**Shorthand**: `npx hypha-cli art` = `npx hypha-cli artifacts`
 
 #### Copy Examples
 
 ```bash
 # Upload a single file
-hypha artifacts cp ./data.csv my-model:data/train.csv
+npx hypha-cli artifacts cp ./data.csv my-model:data/train.csv
 
 # Download a file
-hypha artifacts cp my-model:weights.bin ./local/
+npx hypha-cli artifacts cp my-model:weights.bin ./local/
 
 # Upload a directory (recursive)
-hypha artifacts cp ./dataset/ my-model:data/ -r
+npx hypha-cli artifacts cp ./dataset/ my-model:data/ -r
 
 # Upload and auto-commit
-hypha artifacts cp ./results.json my-model:results.json --commit
+npx hypha-cli artifacts cp ./results.json my-model:results.json --commit
 ```
 
 ## Programmatic API

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hypha-cli",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "description": "Hypha Cloud CLI — manage workspaces, apps, and artifacts",
     "author": "Amun AI AB",
     "license": "SEE LICENSE IN LICENSE",
@@ -18,7 +18,6 @@
         "./cli": "./dist/cli.mjs"
     },
     "scripts": {
-        "postinstall": "node bin/postinstall.mjs",
         "build": "tsc --noEmit && pkgroll",
         "typecheck": "tsc --noEmit",
         "test": "npx tsx test/test-cli-routing.mjs && npx tsx test/test-artifact-path.mjs && npx tsx test/test-apps-commands.mjs && npx tsx test/test-artifacts-commands.mjs && npx tsx test/test-helpers.mjs",

package/bin/postinstall.mjs

@@ -1,78 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * postinstall script for hypha-cli
- *
- * Detects and removes conflicting Python 'hypha' command.
- * The Python hypha package installs a 'hypha' console_script for starting
- * the server, but `python -m hypha.server` is the preferred way to do that.
- *
- * npm runs postinstall in a stripped shell (no ~/.zshrc, no conda init, etc),
- * so `which` can't see all PATH entries. We solve this by running `which -a`
- * inside a login shell to get the user's full PATH.
- */
-
-import { execSync } from 'child_process';
-import { existsSync, readFileSync, unlinkSync } from 'fs';
-
-function isPythonHyphaScript(filePath) {
-    try {
-        const head = readFileSync(filePath, 'utf-8').slice(0, 500);
-        return head.includes('python') && head.includes('from hypha');
-    } catch {
-        return false;
-    }
-}
-
-function findConflictingBinaries() {
-    const found = new Set();
-
-    // Detect user's shell
-    const shell = process.env.SHELL || '/bin/sh';
-
-    // npm runs postinstall in a stripped environment. `zsh -l` (login non-interactive)
-    // skips .zshrc where conda/pyenv add PATH entries. We must use `-i` (interactive)
-    // to source .zshrc, or explicitly source the rc files.
-    for (const cmd of [
-        `${shell} -i -c 'which -a hypha' 2>/dev/null`,   // interactive shell (sources .zshrc/.bashrc)
-        `${shell} -l -c 'which -a hypha' 2>/dev/null`,   // login shell fallback
-        'which -a hypha 2>/dev/null',                      // plain fallback
-    ]) {
-        try {
-            const output = execSync(cmd, { encoding: 'utf-8', timeout: 10000 }).trim();
-            for (const line of output.split('\n')) {
-                const p = line.trim();
-                if (p && existsSync(p) && isPythonHyphaScript(p)) {
-                    found.add(p);
-                }
-            }
-        } catch {
-            // Shell or which not available
-        }
-    }
-
-    return [...found];
-}
-
-function main() {
-    const conflicts = findConflictingBinaries();
-    if (conflicts.length === 0) return;
-
-    for (const binPath of conflicts) {
-        try {
-            unlinkSync(binPath);
-            console.log(`hypha-cli: removed conflicting Python 'hypha' at ${binPath}`);
-        } catch (err) {
-            if (err.code === 'EACCES') {
-                console.log(`hypha-cli: conflicting Python 'hypha' at ${binPath}`);
-                console.log(`           remove it manually: rm ${binPath}`);
-            }
-        }
-    }
-
-    if (conflicts.length > 0) {
-        console.log(`  (use 'python -m hypha.server' to start the Hypha server instead)`);
-    }
-}
-
-main();