@tyvm/knowhow 0.0.108 → 0.0.109-dev.05fe5a0

package/src/commands/services.ts

@@ -0,0 +1,77 @@
+import { includedTools } from "../agents/tools/list";
+import * as allTools from "../agents/tools";
+import { LazyToolsService, services } from "../services";
+import { agents } from "../agents";
+import { ModulesService } from "../services/modules";
+
+/**
+ * Shared service setup used by commands that need full services (chat, agent, worker, etc.)
+ */
+export async function setupServices() {
+  const {
+    Agents,
+    Mcp,
+    Clients,
+    Tools: AllTools,
+    Embeddings,
+    Plugins,
+    Events,
+    MediaProcessor,
+  } = services();
+
+
+  // cli uses LazyTools to keep context slim
+  const Tools = new LazyToolsService();
+
+  Tools.setContext({
+    ...AllTools.getContext(),
+  });
+
+  const agentContext: import("../agents/base/base").AgentContext = {
+    ...services(),
+    Tools,
+  };
+
+  const { Researcher, Developer, Patcher, Setup } = agents({
+    ...agentContext,
+  });
+
+  Agents.registerAgent(Researcher);
+  Agents.registerAgent(Patcher);
+  Agents.registerAgent(Developer);
+  Agents.registerAgent(Setup);
+  Agents.loadAgentsFromConfig(agentContext);
+
+  Tools.defineTools(includedTools, allTools);
+
+  Tools.addContext("Mcp", Mcp);
+
+  Agents.setAgentContext(agentContext);
+
+  console.log("🔌 Connecting to MCP...");
+  try {
+    await Mcp.connectToConfigured(Tools);
+  } catch (mcpError) {
+    const msg = mcpError instanceof Error ? mcpError.message : String(mcpError);
+    console.warn(
+      `⚠ Some MCP servers failed to connect (continuing without them): ${msg}`
+    );
+  }
+  console.log("Connecting to clients...");
+  await Clients.registerConfiguredModels();
+  console.log("✓ Services are set up and ready to go!");
+
+  console.log("📦 Loading modules from config...");
+  const modulesService = new ModulesService();
+  await modulesService.loadModulesFromConfig({
+    Agents,
+    Embeddings,
+    Plugins,
+    Clients,
+    Tools,
+    MediaProcessor,
+    Events
+  });
+
+  return { Tools, Clients };
+}

package/src/commands/workers.ts

@@ -0,0 +1,168 @@
+import { Command } from "commander";
+import { worker } from "../worker";
+import { TUNNEL_MINIMAL_TOOLS } from "../tunnel";
+import { fileSync } from "../fileSync";
+import {
+  startAllWorkers,
+  listWorkerPaths,
+  unregisterWorkerPath,
+  clearWorkerRegistry,
+} from "../workerRegistry";
+
+export function addWorkerCommand(program: Command): void {
+  program
+    .command("worker")
+    .description(
+      "Start worker process and optionally register current directory"
+    )
+    .option("--register", "Register current directory as a worker path")
+    .option(
+      "--share",
+      "Share this worker with your organization (allows other users to use it)"
+    )
+    .option("--unshare", "Make this worker private (only you can use it)")
+    .option("--sandbox", "Run worker in a Docker container for isolation")
+    .option(
+      "--no-sandbox",
+      "Run worker directly on host (disable sandbox mode)"
+    )
+    .option("--passkey", "Set up passkey authentication for this worker")
+    .option("--passkey-reset", "Remove passkey authentication requirement")
+    .action(async (options) => {
+      const { setupServices } = await import("./services");
+      await setupServices();
+      await worker(options);
+    });
+}
+
+export function addWorkersCommand(program: Command): void {
+  program
+    .command("workers")
+    .description("Manage and start all registered workers")
+    .option("--list", "List all registered worker paths")
+    .option("--unregister <path>", "Unregister a worker path")
+    .option("--clear", "Clear all registered worker paths")
+    .action(async (options) => {
+      try {
+        if (options.list) {
+          const workers = await listWorkerPaths();
+          if (workers.length === 0) {
+            console.log("No workers registered.");
+            console.log(
+              "\nTo register a worker, run 'knowhow worker --register' from the worker directory."
+            );
+          } else {
+            console.log(`Registered workers (${workers.length}):`);
+            workers.forEach((workerPath, index) => {
+              console.log(`  ${index + 1}. ${workerPath}`);
+            });
+          }
+          return;
+        }
+
+        if (options.unregister) {
+          await unregisterWorkerPath(options.unregister);
+          return;
+        }
+
+        if (options.clear) {
+          await clearWorkerRegistry();
+          return;
+        }
+
+        // Default action: start all workers
+        const { setupServices } = await import("./services");
+        await setupServices();
+        await startAllWorkers();
+      } catch (error) {
+        console.error("Error managing workers:", error);
+        process.exit(1);
+      }
+    });
+}
+
+export function addTunnelCommand(program: Command): void {
+  program
+    .command("tunnel")
+    .description(
+      "Start a minimal worker with tunnel enabled: exposes local ports to the cloud. " +
+      "Registers essential tools (unlock, lock, listAllowedPorts) so the backend is aware of the worker and ports. " +
+      "If passkey auth is configured, the tunnel is locked until unlocked via tool call or WebSocket auth protocol."
+    )
+    .option(
+      "--share",
+      "Share this tunnel with your organization (allows other users to use it)"
+    )
+    .option("--unshare", "Make this tunnel private (only you can use it)")
+    .action(async (options) => {
+      console.log("🌐 Starting tunnel (minimal worker) mode...");
+      console.log(`   Tools: ${TUNNEL_MINIMAL_TOOLS.join(", ")}`);
+      await worker({
+        ...options,
+        allowedTools: TUNNEL_MINIMAL_TOOLS,
+      });
+    });
+}
+
+export function addFilesCommand(program: Command): void {
+  program
+    .command("files")
+    .description(
+      "Sync files between local filesystem and Knowhow FS (uses fileMounts config)"
+    )
+    .option("--upload", "Force upload direction for all mounts")
+    .option("--download", "Force download direction for all mounts")
+    .option("--config <path>", "Path to knowhow.json", "./knowhow.json")
+    .option("--dry-run", "Print what would be synced without doing it")
+    .action(async (options) => {
+      try {
+        await fileSync(options);
+      } catch (error) {
+        console.error("Error syncing files:", error);
+        process.exit(1);
+      }
+    });
+}
+
+export function addCloudWorkerCommand(program: Command): void {
+  program
+    .command("cloudworker")
+    .description("Create or sync a cloud worker with your local knowhow config")
+    .option(
+      "--init",
+      "Initialize config.files entries based on what exists in .knowhow/ (run once before --push)"
+    )
+    .option(
+      "--create",
+      "Create a new cloud worker with synced config and files"
+    )
+    .option(
+      "--push <uid>",
+      "Push/sync local config and files to an existing cloud worker"
+    )
+    .option(
+      "--pull <id>",
+      "Pull the latest workerConfigJson from a cloud worker and update local config"
+    )
+    .option("--name <name>", "Name for the cloud worker (used with --create)")
+    .option("--dry-run", "Print what would be synced without doing it")
+    .action(async (options) => {
+      try {
+        const { cloudWorker, pullCloudWorkerConfig, initCloudWorker } = await import(
+          "../cloudWorker"
+        );
+        if (options.init) {
+          await initCloudWorker({ dryRun: options.dryRun });
+          return;
+        }
+        if (options.pull) {
+          await pullCloudWorkerConfig({ id: options.pull });
+        } else {
+          await cloudWorker(options);
+        }
+      } catch (error) {
+        console.error("Error running cloudworker:", error);
+        process.exit(1);
+      }
+    });
+}

package/src/config.ts

@@ -168,6 +168,27 @@ export async function init() {
   console.log("Initializing global knowhow config at ~/.knowhow");
   const globalConfigDir = await ensureGlobalConfigDir();
 
+  // Ensure the script module is registered in the global config so that
+  // `knowhow script` and the `executeScript` tool are available everywhere.
+  const SCRIPT_MODULE = "@tyvm/knowhow-module-script";
+  const globalConfigPath = path.join(globalConfigDir, "knowhow.json");
+  try {
+    const rawGlobal = fs.existsSync(globalConfigPath)
+      ? fs.readFileSync(globalConfigPath, "utf8")
+      : JSON.stringify(defaultConfig, null, 2);
+    const globalConf = JSON.parse(rawGlobal) as Config;
+    if (!globalConf.modules) {
+      globalConf.modules = [];
+    }
+    if (!globalConf.modules.includes(SCRIPT_MODULE)) {
+      globalConf.modules.push(SCRIPT_MODULE);
+      fs.writeFileSync(globalConfigPath, JSON.stringify(globalConf, null, 2));
+      console.log(`✅ Added ${SCRIPT_MODULE} to ~/.knowhow/knowhow.json modules`);
+    }
+  } catch (e) {
+    console.warn(`⚠ Could not update global config to add script module:`, e);
+  }
+
   // create the folder structure
   console.log("Initializing local knowhow config at ./.knowhow");
   await mkdir(".knowhow", { recursive: true });
@@ -287,6 +308,22 @@ export async function getGlobalConfig(): Promise<Config> {
   }
 }
 
+export async function updateGlobalConfig(config: Config) {
+  if (!config || typeof config !== "object") {
+    throw new Error("Invalid config object");
+  }
+
+  const globalConfigDir = getGlobalConfigDir();
+  await mkdir(globalConfigDir, { recursive: true });
+  const globalConfigPath = path.join(globalConfigDir, "knowhow.json");
+
+  if (fs.existsSync(globalConfigPath)) {
+    await fs.promises.copyFile(globalConfigPath, globalConfigPath + ".bak");
+  }
+
+  await writeFile(globalConfigPath, JSON.stringify(config, null, 2));
+}
+
 export async function migrateConfig() {
   // Apply migrations, used to keep config structure up to date.
   if (!fs.existsSync(".knowhow/knowhow.json")) {

package/src/fileSync.ts

@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import * as path from "path";
+import * as os from "os";
 import { KnowhowSimpleClient, KNOWHOW_API_URL } from "./services/KnowhowClient";
 import { loadJwt } from "./login";
 import { getConfig } from "./config";
@@ -7,6 +8,8 @@ import { services } from "./services";
 import { S3Service } from "./services/S3";
 import { getHashes, hasFileChangedSinceUpload, saveUploadHash, isLocalFileMatchingRemote, isLocalFileMatchingDownloadHash, saveDownloadHash } from "./hashes";
 
+export const DEFAULT_BATCH_SIZE = 5;
+
 export interface FileSyncOptions {
   upload?: boolean;
   download?: boolean;
@@ -15,6 +18,33 @@ export interface FileSyncOptions {
   dryRun?: boolean;
 }
 
+/**
+ * Run an array of async tasks in batches of `batchSize` at a time.
+ * Returns results in the same order as the input tasks.
+ */
+export async function batchRun<T>(
+  tasks: (() => Promise<T>)[],
+  batchSize: number = DEFAULT_BATCH_SIZE
+): Promise<T[]> {
+  const results: T[] = [];
+  for (let i = 0; i < tasks.length; i += batchSize) {
+    const batch = tasks.slice(i, i + batchSize);
+    const batchResults = await Promise.all(batch.map((t) => t()));
+    results.push(...batchResults);
+  }
+  return results;
+}
+
+/**
+ * Expands a leading ~ to the user's home directory
+ */
+function expandHome(p: string): string {
+  if (p === "~" || p.startsWith("~/") || p.startsWith("~\\")) {
+    return path.join(os.homedir(), p.slice(1));
+  }
+  return p;
+}
+
 /**
  * Returns true if the path looks like a directory (ends with /)
  */
@@ -25,7 +55,7 @@ function isDirectoryPath(p: string): boolean {
 /**
  * Recursively list all files in a local directory, returning relative paths
  */
-function listFilesRecursively(dir: string): string[] {
+export function listFilesRecursively(dir: string): string[] {
   const results: string[] = [];
   if (!fs.existsSync(dir)) return results;
   const entries = fs.readdirSync(dir, { withFileTypes: true });
@@ -83,7 +113,8 @@ export async function fileSync(options: FileSyncOptions = {}) {
 
   // Process each file mount
   for (const mount of config.files) {
-    const { remotePath, localPath, direction = "download" } = mount;
+    const { remotePath, localPath: rawLocalPath, direction = "download" } = mount;
+    const localPath = expandHome(rawLocalPath);
 
     // Determine actual direction based on flags and config
     let actualDirection = direction;
@@ -126,11 +157,10 @@ export async function fileSync(options: FileSyncOptions = {}) {
   }
 }
 
-
 /**
  * Download a file from Knowhow FS to local filesystem
  */
-async function downloadFile(
+export async function downloadFile(
   client: KnowhowSimpleClient,
   s3Service: S3Service,
   remotePath: string,
@@ -186,7 +216,7 @@ async function downloadFile(
 /**
  * Upload a file from local filesystem to Knowhow FS
  */
-async function uploadFile(
+export async function uploadFile(
   client: KnowhowSimpleClient,
   s3Service: S3Service,
   remotePath: string,
@@ -215,7 +245,7 @@ async function uploadFile(
   }
 
   // Get presigned upload URL
-  const presignedUrl = await client.getOrgFilePresignedUploadUrl(remotePath);
+  const presignedUrl = await client.getOrgFilePresignedUploadUrl(remotePath, localPath);
 
   // Upload file using presigned URL
   await s3Service.uploadToPresignedUrl(presignedUrl, localPath);
@@ -261,26 +291,28 @@ export async function uploadDirectory(
 
   console.log(`   Found ${localFiles.length} local file(s)`);
 
-  let count = 0;
-  for (const relFile of localFiles) {
+  const tasks = localFiles.map((relFile) => async () => {
     const localFilePath = localDir + relFile;
     const remoteFilePath = remoteDir + relFile;
     try {
       await uploadFile(client, s3Service, remoteFilePath, localFilePath, dryRun);
-      count++;
+      return 1;
     } catch (error) {
       console.error(
         `   ❌ Failed to upload ${localFilePath}, skipping: ${error.message}`
       );
+      return 0;
     }
-  }
-  return count;
+  });
+
+  const counts = await batchRun(tasks);
+  return counts.reduce((sum, n) => sum + n, 0);
 }
 
 /**
  * Download all files from a remote directory path to a local directory
  */
-async function downloadDirectory(
+export async function downloadDirectory(
   client: KnowhowSimpleClient,
   s3Service: S3Service,
   remotePath: string,
@@ -313,8 +345,7 @@ async function downloadDirectory(
 
   console.log(`   Found ${matchingFiles.length} remote file(s)`);
 
-  let count = 0;
-  for (const f of matchingFiles) {
+  const tasks = matchingFiles.map((f) => async () => {
     const fullRemotePath = f.folderPath.endsWith("/")
       ? f.folderPath + f.fileName
       : f.folderPath + "/" + f.fileName;
@@ -322,7 +353,9 @@ async function downloadDirectory(
     const relativePath = fullRemotePath.slice(remoteDir.length);
     const localFilePath = localDir + relativePath;
     await downloadFile(client, s3Service, fullRemotePath, localFilePath, dryRun);
-    count++;
-  }
-  return count;
+    return 1;
+  });
+
+  const counts = await batchRun(tasks);
+  return counts.reduce((sum, n) => sum + n, 0);
 }

package/src/index.ts

@@ -53,6 +53,7 @@ export * as ai from "./ai";
 
 // Export module system types for external modules
 export * from "./services/modules/types";
+export { ModulesService } from "./services/modules";
 // Export plugin types for external plugins
 export { PluginBase } from "./plugins/PluginBase";
 export { PluginMeta, Plugin, PluginContext } from "./plugins/types";
@@ -138,6 +139,23 @@ export async function upload() {
       if (!source.remoteId) {
         throw new Error("remoteId is required for knowhow uploads");
       }
+      // Warn if the local embeddingModel differs from the one stored on the backend
+      try {
+        const remoteEmbedding = await knowhowApiClient.getOrgEmbedding(source.remoteId);
+        const localModel = config.embeddingModel || EmbeddingModels.openai.EmbeddingAda2;
+        const remoteModel = remoteEmbedding?.modelName;
+        if (remoteModel && remoteModel !== localModel) {
+          console.warn(
+            `⚠️  WARNING: Embedding model mismatch for "${remoteEmbedding.name}" (remoteId: ${source.remoteId}).\n` +
+            `   Local config.embeddingModel:  ${localModel}\n` +
+            `   Backend embedding modelName:  ${remoteModel}\n` +
+            `   Vectors generated with different models are not comparable — search results will be incorrect.\n` +
+            `   Update your config.embeddingModel to "${remoteModel}" or update the backend embedding to "${localModel}".`
+          );
+        }
+      } catch (e) {
+        // Non-fatal — don't block upload if metadata fetch fails
+      }
       const url = await knowhowApiClient.getPresignedUploadUrl(source);
       console.log("Uploading to", url);
       await AwsS3.uploadToPresignedUrl(url, source.output);

package/src/logger.ts

@@ -0,0 +1,197 @@
+import type { LogLevel } from "./services/EventService";
+
+/**
+ * App-wide logger utility.
+ *
+ * Features:
+ * 1. `logger.info/warn/error(source, message)` — routes through EventService
+ * 2. `Logger.of("ClassName")` — creates a bound logger so you don't repeat the source
+ * 3. `logger.installConsoleOverload()` — replaces console.log/warn/error/info with
+ *    our closure, so ALL output (including third-party modules) goes through us
+ * 4. `logger.silence()` / `logger.unsilence()` — suppress all output, useful for
+ *    commands that need clean stdout (e.g. github-credentials)
+ *
+ * Usage (module-level):
+ *   import { logger } from "../logger";
+ *   logger.info("MyService", "Something happened");
+ *
+ * Usage (class-level):
+ *   import { Logger } from "../logger";
+ *   class MyClass {
+ *     private logger = Logger.of("MyClass");
+ *     doThing() { this.logger.info("Something happened"); }
+ *   }
+ *
+ * Silence mode (for clean-stdout commands):
+ *   logger.silence();   // suppress everything
+ *   // ... do work that must produce clean stdout ...
+ *   logger.unsilence(); // restore
+ */
+
+// ---- Internal state ---------------------------------------------------------
+
+let silenced = false;
+
+// Original console methods — saved before any overload is installed
+const _originalConsole = {
+  log: console.log.bind(console),
+  warn: console.warn.bind(console),
+  error: console.error.bind(console),
+  info: console.info.bind(console),
+};
+
+let consoleOverloadInstalled = false;
+
+// ---- EventService lazy accessor ---------------------------------------------
+
+function getEvents() {
+  try {
+    const { services } = require("./services") as typeof import("./services");
+    return services().Events;
+  } catch {
+    return null;
+  }
+}
+
+// ---- Core emit logic --------------------------------------------------------
+
+function emit(source: string, message: string, level: LogLevel): void {
+  if (silenced) return;
+
+  try {
+    const events = getEvents();
+    if (events) {
+      events.log(source, message, level);
+      return;
+    }
+  } catch {
+    // fall through to direct console output
+  }
+
+  // Fallback: use original console methods (bypasses any overload we installed)
+  const prefix = source ? `[${source}] ` : "";
+  if (level === "warn") _originalConsole.warn(`${prefix}${message}`);
+  else if (level === "error") _originalConsole.error(`${prefix}${message}`);
+  else _originalConsole.log(`${prefix}${message}`);
+}
+
+// ---- Bound logger (returned by Logger.of) -----------------------------------
+
+export interface BoundLogger {
+  log(message: string, level?: LogLevel): void;
+  info(message: string): void;
+  warn(message: string): void;
+  error(message: string): void;
+}
+
+function makeBoundLogger(source: string): BoundLogger {
+  return {
+    log(message: string, level: LogLevel = "info"): void {
+      emit(source, message, level);
+    },
+    info(message: string): void {
+      emit(source, message, "info");
+    },
+    warn(message: string): void {
+      emit(source, message, "warn");
+    },
+    error(message: string): void {
+      emit(source, message, "error");
+    },
+  };
+}
+
+// ---- Public API -------------------------------------------------------------
+
+export const logger = {
+  log(source: string, message: string, level: LogLevel = "info"): void {
+    emit(source, message, level);
+  },
+
+  info(source: string, message: string): void {
+    emit(source, message, "info");
+  },
+
+  warn(source: string, message: string): void {
+    emit(source, message, "warn");
+  },
+
+  error(source: string, message: string): void {
+    emit(source, message, "error");
+  },
+
+  /**
+   * Suppress all log output. Useful for commands that need clean stdout
+   * (e.g. git credential helpers). All logger.* calls and overloaded
+   * console.* calls become no-ops until unsilence() is called.
+   */
+  silence(): void {
+    silenced = true;
+  },
+
+  /**
+   * Restore log output after a silence() call.
+   */
+  unsilence(): void {
+    silenced = false;
+  },
+
+  /**
+   * Returns true if the logger is currently silenced.
+   */
+  isSilenced(): boolean {
+    return silenced;
+  },
+
+  /**
+   * Install console overload. After this call, console.log/warn/error/info
+   * all route through our closure (respecting silence mode).
+   * Safe to call multiple times — only installs once.
+   *
+   * Call this early in CLI startup (before any modules are loaded) to ensure
+   * third-party module logs don't bypass the silence mechanism.
+   */
+  installConsoleOverload(): void {
+    if (consoleOverloadInstalled) return;
+    consoleOverloadInstalled = true;
+
+    const route = (originalFn: (...args: any[]) => void, args: any[]) => {
+      if (silenced) return;
+      originalFn(...args);
+    };
+
+    console.log = (...args: any[]) => route(_originalConsole.log, args);
+    console.info = (...args: any[]) => route(_originalConsole.info, args);
+    console.warn = (...args: any[]) => route(_originalConsole.warn, args);
+    // Note: console.error is intentionally NOT overloaded — real errors (stack
+    // traces, crash reports) should always be visible. Only suppress via silence().
+    // If you want to suppress errors too, call logger.silence() which checks the flag
+    // before the overloaded console.warn/log routes reach here anyway.
+  },
+
+  /**
+   * Remove the console overload and restore original console methods.
+   */
+  uninstallConsoleOverload(): void {
+    if (!consoleOverloadInstalled) return;
+    console.log = _originalConsole.log;
+    console.info = _originalConsole.info;
+    console.warn = _originalConsole.warn;
+    consoleOverloadInstalled = false;
+  },
+};
+
+/**
+ * Factory for creating a bound logger with a fixed source name.
+ * Ideal for class-level loggers:
+ *
+ *   class MyClass {
+ *     private logger = Logger.of("MyClass");
+ *     doThing() { this.logger.info("hello"); }
+ *   }
+ */
+export const Logger = {
+  of(source: string): BoundLogger {
+    return makeBoundLogger(source);
+  },
+};