@archildata/just-bash 0.1.0 → 0.1.2

package/README.md

@@ -78,7 +78,17 @@ const fs = new ArchilFs(client, {
 The package includes an interactive shell for testing:
 
 ```bash
-ARCHIL_REGION=aws-us-east-1 ARCHIL_DISK=myaccount/mydisk ARCHIL_TOKEN=xxx npx @archildata/just-bash
+# Positional arguments (recommended)
+npx @archildata/just-bash aws-us-east-1 myaccount/mydisk
+
+# With flags
+npx @archildata/just-bash --region aws-us-east-1 --disk myaccount/mydisk
+
+# With token (use env var to keep out of shell history)
+ARCHIL_TOKEN=xxx npx @archildata/just-bash aws-us-east-1 myaccount/mydisk
+
+# With debug logging
+npx @archildata/just-bash aws-us-east-1 myaccount/mydisk --log-level debug
 ```
 
 Shell commands:
@@ -134,6 +144,8 @@ DEBUG=archil:* node myapp.js
 - **Chunked reads** - Large files read in 4 MiB chunks
 - **Native protocol** - Direct Archil protocol access, no FUSE overhead
 
+> **Note:** For best performance, run your application in the same region as your Archil disk (e.g., if your disk is in `aws-us-east-1`, deploy your app to AWS us-east-1).
+
 ## License
 
 MIT

package/{bin/shell.ts → dist/shell.js}

@@ -1,37 +1,44 @@
-#!/usr/bin/env npx tsx
-/**
- * Interactive just-bash shell with Archil filesystem
- *
- * Usage:
- *   ARCHIL_REGION=aws-us-east-1 ARCHIL_DISK=myaccount/mydisk ARCHIL_TOKEN=xxx npx tsx bin/shell.ts
- */
+#!/usr/bin/env node
 
+// bin/shell.ts
 import * as readline from "readline";
+import { Command } from "commander";
 import { ArchilClient } from "@archildata/client";
 import { Bash } from "just-bash";
-import { ArchilFs } from "../src/ArchilFs.js";
-
+import { ArchilFs } from "@archildata/just-bash";
+var program = new Command();
+program.name("archil-shell").description("Interactive bash shell with Archil filesystem").version("0.1.0").argument("[region]", "Region identifier (e.g., aws-us-east-1)").argument("[disk]", "Disk name (e.g., myaccount/mydisk)").option("-r, --region <region>", "Region identifier (e.g., aws-us-east-1)").option("-d, --disk <disk>", "Disk name (e.g., myaccount/mydisk)").option("-t, --token <token>", "Auth token (defaults to IAM)").option("-l, --log-level <level>", "Log level: trace, debug, info, warn, error").addHelpText("after", `
+Environment variables:
+  ARCHIL_REGION     Fallback for --region
+  ARCHIL_DISK       Fallback for --disk
+  ARCHIL_TOKEN      Fallback for --token (recommended for secrets)
+  ARCHIL_LOG_LEVEL  Fallback for --log-level
+
+Examples:
+  $ npx @archildata/just-bash aws-us-east-1 myaccount/mydisk
+  $ npx @archildata/just-bash --region aws-us-east-1 --disk myaccount/mydisk
+  $ ARCHIL_TOKEN=xxx npx @archildata/just-bash aws-us-east-1 myaccount/mydisk
+  $ npx @archildata/just-bash -r aws-us-east-1 -d myaccount/mydisk -l debug
+`);
+program.parse();
+var opts = program.opts();
+var args = program.args;
+var region = args[0] || opts.region || process.env.ARCHIL_REGION;
+var diskName = args[1] || opts.disk || process.env.ARCHIL_DISK;
+var authToken = opts.token || process.env.ARCHIL_TOKEN;
+var logLevel = opts.logLevel || process.env.ARCHIL_LOG_LEVEL;
+if (!region || !diskName) {
+  console.error("Error: region and disk are required\n");
+  console.error("Usage:");
+  console.error("  npx @archildata/just-bash <region> <disk>");
+  console.error("  npx @archildata/just-bash --region <region> --disk <disk>");
+  console.error("\nExamples:");
+  console.error("  npx @archildata/just-bash aws-us-east-1 myaccount/mydisk");
+  console.error("  ARCHIL_TOKEN=xxx npx @archildata/just-bash aws-us-east-1 myaccount/mydisk");
+  console.error("\nRun with --help for more options.");
+  process.exit(1);
+}
 async function main() {
-  const region = process.env.ARCHIL_REGION;
-  const diskName = process.env.ARCHIL_DISK;
-  const authToken = process.env.ARCHIL_TOKEN;
-  const logLevel = process.env.ARCHIL_LOG_LEVEL; // e.g., "debug", "info", "warn", "error", "trace"
-
-  if (!region || !diskName) {
-    console.error("Missing required environment variables:");
-    console.error("  ARCHIL_REGION    - e.g., aws-us-east-1");
-    console.error("  ARCHIL_DISK      - e.g., myaccount/mydisk");
-    console.error("  ARCHIL_TOKEN     - (optional) auth token, defaults to IAM");
-    console.error("  ARCHIL_LOG_LEVEL - (optional) log level: trace, debug, info, warn, error");
-    console.error("");
-    console.error("Usage:");
-    console.error("  ARCHIL_REGION=aws-us-east-1 ARCHIL_DISK=myaccount/mydisk npx tsx bin/shell.ts");
-    console.error("");
-    console.error("For debug logging:");
-    console.error("  ARCHIL_LOG_LEVEL=debug ARCHIL_REGION=... ARCHIL_DISK=... npx tsx bin/shell.ts");
-    process.exit(1);
-  }
-
   console.log("Connecting to Archil...");
   console.log(`  Region: ${region}`);
   console.log(`  Disk: ${diskName}`);
@@ -40,57 +47,44 @@ async function main() {
     console.log(`  Log level: ${logLevel}`);
   }
   console.log("");
-
-  let client: ArchilClient;
+  let client;
   try {
     client = await ArchilClient.connect({
       region,
       diskName,
-      authToken: authToken || undefined,
-      logLevel,
+      authToken: authToken || void 0,
+      logLevel
     });
     console.log("Connected!");
   } catch (err) {
     console.error("Failed to connect:", err instanceof Error ? err.message : err);
     process.exit(1);
   }
-
-  // Create filesystem adapter
   const fs = new ArchilFs(client);
-
-  // Create bash environment
   const bash = new Bash({ fs });
-
-  // Cleanup function to release delegations and close connection
   let cleaningUp = false;
-  const cleanup = async (signal?: string) => {
+  const cleanup = async (signal) => {
     if (cleaningUp) return;
     cleaningUp = true;
-
     if (signal) {
-      console.log(`\nReceived ${signal}, cleaning up...`);
+      console.log(`
+Received ${signal}, cleaning up...`);
     } else {
       console.log("\nGoodbye!");
     }
-
     try {
-      // close() releases all delegations and cleans up resources
       const released = await client.close();
       if (released > 0) {
-        console.log(`Released ${released} delegation${released > 1 ? 's' : ''}`);
+        console.log(`Released ${released} delegation${released > 1 ? "s" : ""}`);
       }
     } catch (err) {
       console.error("Error during cleanup:", err instanceof Error ? err.message : err);
     }
-
     process.exit(0);
   };
-
-  // Handle signals for graceful shutdown
-  process.on('SIGINT', () => cleanup('SIGINT'));
-  process.on('SIGTERM', () => cleanup('SIGTERM'));
-  process.on('SIGHUP', () => cleanup('SIGHUP'));
-
+  process.on("SIGINT", () => cleanup("SIGINT"));
+  process.on("SIGTERM", () => cleanup("SIGTERM"));
+  process.on("SIGHUP", () => cleanup("SIGHUP"));
   console.log("");
   console.log("=== Archil just-bash shell ===");
   console.log("Type bash commands to interact with the filesystem.");
@@ -101,47 +95,34 @@ async function main() {
   console.log("  archil help                       - Show archil commands");
   console.log("Type 'exit' or Ctrl+D to quit.");
   console.log("");
-
-  // Create readline interface for interactive input
   const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout,
-    prompt: "archil$ ",
+    prompt: "archil$ "
   });
-
   let cwd = "/";
-
   const prompt = () => {
     rl.setPrompt(`archil:${cwd}$ `);
     rl.prompt();
   };
-
   prompt();
-
-  // Helper to resolve a path relative to cwd
-  const resolvePath = (path: string): string => {
+  const resolvePath = (path) => {
     if (path.startsWith("/")) {
       return path;
     }
     return cwd === "/" ? "/" + path : cwd + "/" + path;
   };
-
-  // Handle archil checkout/checkin commands
-  const handleArchilCommand = async (command: string): Promise<boolean> => {
+  const handleArchilCommand = async (command) => {
     const parts = command.split(/\s+/);
     if (parts[0] !== "archil") {
       return false;
     }
-
     const subcommand = parts[1];
     const targetPath = parts[2];
-
     if (subcommand === "checkout") {
-      // Parse flags and path
-      const args = parts.slice(2);
-      const force = args.includes("--force") || args.includes("-f");
-      const pathArg = args.find(a => !a.startsWith("-"));
-
+      const args2 = parts.slice(2);
+      const force = args2.includes("--force") || args2.includes("-f");
+      const pathArg = args2.find((a) => !a.startsWith("-"));
       if (!pathArg) {
         console.error("Usage: archil checkout [--force|-f] <path>");
         return true;
@@ -156,7 +137,6 @@ async function main() {
       }
       return true;
     }
-
     if (subcommand === "checkin") {
       if (!targetPath) {
         console.error("Usage: archil checkin <path>");
@@ -172,7 +152,6 @@ async function main() {
       }
       return true;
     }
-
     if (subcommand === "list-delegations" || subcommand === "delegations") {
       try {
         const delegations = client.listDelegations();
@@ -189,7 +168,6 @@ async function main() {
       }
       return true;
     }
-
     if (subcommand === "help" || !subcommand) {
       console.log("Archil commands:");
       console.log("  archil checkout [--force|-f] <path>  - Acquire write delegation");
@@ -200,48 +178,36 @@ async function main() {
       console.log("The --force flag revokes any existing delegation from other clients.");
       return true;
     }
-
     console.error(`Unknown archil command: ${subcommand}`);
     console.error("Run 'archil help' for available commands");
     return true;
   };
-
   rl.on("line", async (line) => {
     const trimmed = line.trim();
-
     if (trimmed === "exit" || trimmed === "quit") {
       await cleanup();
       return;
     }
-
     if (!trimmed) {
       prompt();
       return;
     }
-
-    // Pause readline while we process the command
     rl.pause();
-
     try {
-      // Check for archil commands first
       if (trimmed.startsWith("archil")) {
         await handleArchilCommand(trimmed);
         rl.resume();
         prompt();
         return;
       }
-
-      // Execute command with current working directory
       const result = await bash.exec(trimmed, {
         cwd,
         env: {
           HOME: "/",
           USER: "archil",
-          PWD: cwd,
-        },
+          PWD: cwd
+        }
       });
-
-      // Print output
       if (result.stdout) {
         process.stdout.write(result.stdout);
         if (!result.stdout.endsWith("\n")) {
@@ -254,22 +220,17 @@ async function main() {
           console.error("");
         }
       }
-
-      // Update cwd if command changed it
       if (result.env?.PWD && result.env.PWD !== cwd) {
         cwd = result.env.PWD;
       }
     } catch (err) {
       console.error("Error:", err instanceof Error ? err.message : err);
     }
-
     rl.resume();
     prompt();
   });
-
   rl.on("close", () => cleanup());
 }
-
 main().catch((err) => {
   console.error("Fatal error:", err);
   process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/just-bash",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Archil filesystem adapter for just-bash",
   "type": "module",
   "main": "dist/index.js",
@@ -13,14 +13,13 @@
     }
   },
   "bin": {
-    "archil-shell": "./bin/shell.ts"
+    "archil-shell": "./dist/shell.js"
   },
   "files": [
-    "dist",
-    "bin"
+    "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsup src/index.ts --format cjs,esm --dts && tsup bin/shell.ts --format esm --outDir dist --no-splitting --external @archildata/just-bash",
     "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "lint": "eslint src/",
     "typecheck": "tsc --noEmit",
@@ -28,6 +27,7 @@
   },
   "dependencies": {
     "@archildata/client": "^0.1.0",
+    "commander": "^14.0.3",
     "debug": "^4.3.4",
     "just-bash": "^2.7.0"
   },