@tyvm/knowhow 0.0.107 → 0.0.108-dev.4a8ba55

package/src/commands/modules.ts

@@ -0,0 +1,182 @@
+import { Command } from "commander";
+import { execSync } from "child_process";
+import { getConfig, getGlobalConfig, updateConfig, updateGlobalConfig } from "../config";
+
+// Default built-in modules that `knowhow modules setup` adds to the config.
+export const BUILTIN_MODULES = [
+  "@tyvm/knowhow-module-script",
+  "@tyvm/knowhow-module-terminal",
+];
+
+export function addModulesCommand(program: Command): void {
+  const modulesCmd = program
+    .command("modules")
+    .description("Manage knowhow modules (install, add to config, list)");
+
+  modulesCmd
+    .command("setup")
+    .description(
+      "Add default built-in modules to your config and install them via npm"
+    )
+    .option("--global", "Use the global config (~/.knowhow/knowhow.json)")
+    .action(async (opts) => {
+      try {
+        const isGlobal: boolean = opts.global ?? false;
+        const cfg = isGlobal ? await getGlobalConfig() : await getConfig();
+        const configLabel = isGlobal
+          ? "~/.knowhow/knowhow.json"
+          : ".knowhow/knowhow.json";
+
+        if (!cfg.modules) cfg.modules = [];
+
+        const toAdd = BUILTIN_MODULES.filter(
+          (m) => !cfg.modules!.includes(m)
+        );
+
+        if (toAdd.length === 0) {
+          console.log(
+            `✅ All default modules are already in ${configLabel}. Nothing to do.`
+          );
+          return;
+        }
+
+        // Install packages that are not local file paths
+        for (const mod of toAdd) {
+          if (!mod.startsWith(".") && !mod.startsWith("/")) {
+            console.log(`📦 Installing ${mod}...`);
+            const installFlag = isGlobal ? "-g" : "";
+            execSync(`npm install ${installFlag} ${mod}`, {
+              stdio: "inherit",
+              encoding: "utf-8",
+            });
+          }
+          cfg.modules!.push(mod);
+          console.log(`✅ Added ${mod} to ${configLabel}`);
+        }
+
+        if (isGlobal) {
+          await updateGlobalConfig(cfg);
+        } else {
+          await updateConfig(cfg);
+        }
+
+        console.log(
+          `\n🎉 Setup complete! ${toAdd.length} module(s) added to ${configLabel}`
+        );
+      } catch (error) {
+        console.error("Error during modules setup:", error.message ?? error);
+        process.exit(1);
+      }
+    });
+
+  modulesCmd
+    .command("install [module]")
+    .description(
+      "Install a module via npm and add it to your config. " +
+      "If no module name is given, installs all modules already in the config."
+    )
+    .option("--global", "Use the global config (~/.knowhow/knowhow.json)")
+    .action(async (moduleName: string | undefined, opts) => {
+      try {
+        const isGlobal: boolean = opts.global ?? false;
+        const cfg = isGlobal ? await getGlobalConfig() : await getConfig();
+        const configLabel = isGlobal
+          ? "~/.knowhow/knowhow.json"
+          : ".knowhow/knowhow.json";
+
+        if (!cfg.modules) cfg.modules = [];
+
+        if (!moduleName) {
+          // No module specified — install everything already in the config
+          const installable = cfg.modules.filter(
+            (m) => !m.startsWith(".") && !m.startsWith("/")
+          );
+          if (installable.length === 0) {
+            console.log(
+              `ℹ No installable modules found in ${configLabel}.`
+            );
+            return;
+          }
+          console.log(
+            `📦 Installing ${installable.length} module(s) from ${configLabel}...`
+          );
+          const installFlag = isGlobal ? "-g" : "";
+          for (const mod of installable) {
+            console.log(`  📦 Installing ${mod}...`);
+            execSync(`npm install ${installFlag} ${mod}`, {
+              stdio: "inherit",
+              encoding: "utf-8",
+            });
+            console.log(`  ✅ Installed ${mod}`);
+          }
+          console.log(`\n🎉 All modules installed!`);
+          return;
+        }
+
+        // Install the specified module
+        const installFlag = isGlobal ? "-g" : "";
+        console.log(`📦 Installing ${moduleName}...`);
+        execSync(`npm install ${installFlag} ${moduleName}`, {
+          stdio: "inherit",
+          encoding: "utf-8",
+        });
+        console.log(`✅ Installed ${moduleName}`);
+
+        // Add to config if not already there
+        if (!cfg.modules.includes(moduleName)) {
+          cfg.modules.push(moduleName);
+          if (isGlobal) {
+            await updateGlobalConfig(cfg);
+          } else {
+            await updateConfig(cfg);
+          }
+          console.log(`✅ Added ${moduleName} to ${configLabel}`);
+        } else {
+          console.log(`ℹ ${moduleName} is already in ${configLabel}`);
+        }
+      } catch (error) {
+        console.error("Error during module install:", error.message ?? error);
+        process.exit(1);
+      }
+    });
+
+  modulesCmd
+    .command("list")
+    .description("List all modules in your config")
+    .option("--global", "Show global config modules only")
+    .action(async (opts) => {
+      try {
+        const isGlobal: boolean = opts.global ?? false;
+        const globalCfg = await getGlobalConfig();
+        const localCfg = isGlobal ? null : await getConfig();
+
+        const globalModules = globalCfg.modules || [];
+        const localModules = localCfg?.modules || [];
+
+        if (isGlobal) {
+          console.log(`\n🌐 Global modules (~/.knowhow/knowhow.json):`);
+          if (globalModules.length === 0) {
+            console.log("  (none)");
+          } else {
+            globalModules.forEach((m, i) => console.log(`  ${i + 1}. ${m}`));
+          }
+        } else {
+          console.log(`\n🌐 Global modules (~/.knowhow/knowhow.json):`);
+          if (globalModules.length === 0) {
+            console.log("  (none)");
+          } else {
+            globalModules.forEach((m, i) => console.log(`  ${i + 1}. ${m}`));
+          }
+          console.log(`\n📁 Local modules (.knowhow/knowhow.json):`);
+          if (localModules.length === 0) {
+            console.log("  (none)");
+          } else {
+            localModules.forEach((m, i) => console.log(`  ${i + 1}. ${m}`));
+          }
+        }
+      } catch (error) {
+        console.error("Error listing modules:", error.message ?? error);
+        process.exit(1);
+      }
+    });
+}

package/src/commands/services.ts

@@ -0,0 +1,72 @@
+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,
+    MediaProcessor,
+  } = services();
+  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,
+  });
+
+  return { Tools, Clients };
+}

package/src/commands/workers.ts

@@ -0,0 +1,160 @@
+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(
+      "--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 } = await import(
+          "../cloudWorker"
+        );
+        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/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/plugins/embedding.ts

@@ -20,9 +20,12 @@ export class EmbeddingPlugin extends PluginBase {
 
   constructor(context) {
     super(context);
-    
+
     // Subscribe to file:post-edit events
-    this.context.Events.on("file:post-edit", this.handleFilePostEdit.bind(this));
+    this.context.Events.on(
+      "file:post-edit",
+      this.handleFilePostEdit.bind(this)
+    );
   }
 
   async embed() {
@@ -68,10 +71,12 @@ export class EmbeddingPlugin extends PluginBase {
       this.log(`Reading entry ${entry.id}`);
     }
 
-    const contextLength = JSON.stringify(context).split(" ").length;
+    const ids = context.map((entry) => entry.id);
+
+    const contextLength = JSON.stringify(ids).split(" ").length;
     this.log(`Found ${context.length} entries. Loading ${contextLength} words`);
 
-    return `EMBEDDING PLUGIN: Our knowledgebase contains this information which can be used to answer the question:
-    ${JSON.stringify(context)}`;
+    return `EMBEDDING PLUGIN: Our knowledgebase indicates these embedding entries may be related to the question:
+    ${JSON.stringify(ids)}`;
   }
-}
+}

package/src/plugins/plugins.ts

@@ -1,5 +1,4 @@
 import { Plugin, PluginContext } from "./types";
-import { Config } from "../types";
 import { VimPlugin } from "./vim";
 import { LinterPlugin } from "./LinterPlugin";
 import { LanguagePlugin } from "./language";
@@ -49,26 +48,6 @@ export class PluginService {
     return instance.meta.key;
   }
 
-  /**
-   * Load plugins from config's pluginPackages map.
-   * Each entry maps a plugin key to an npm package name or file path.
-   * Errors are caught and logged as warnings without crashing.
-   */
-  async loadPluginsFromConfig(config: Config): Promise<void> {
-    const pluginPackages = config.pluginPackages || {};
-    for (const [key, spec] of Object.entries(pluginPackages)) {
-      try {
-        await this.loadPlugin(spec);
-      } catch (error) {
-        this.events?.log(
-          "PluginService",
-          `Failed to load plugin "${key}" from "${spec}": ${error instanceof Error ? error.message : error}`,
-          "warn"
-        );
-      }
-    }
-  }
-
   /** Disable a plugin by its key; returns `true` if found. */
   disablePlugin(key: string): boolean {
     const p = this.pluginMap.get(key);

package/src/plugins/vim.ts

@@ -73,22 +73,11 @@ export class VimPlugin extends PluginBase {
 
   async call() {
     const vimFiles = await this.getVimFiles();
-    const fileContents = await Promise.all(
-      vimFiles.map(async (f) => {
-        const loaded = await this.getFileContents(f);
-
-        const preview =
-          loaded.content.length > 1000
-            ? loaded.content.slice(0, 1000) +
-              "... file trimmed, read file for full content"
-            : loaded.content;
-
-        return {
-          sourceFile: loaded.filePath,
-          content: loaded.content.slice(0, 1000),
-        };
-      })
-    );
+    const fileContents = vimFiles.map((f) => {
+      return {
+        sourceFile: f,
+      };
+    });
     if (fileContents.length === 0) {
       return "VIM PLUGIN: No files open in vim";
     }

package/src/processors/JsonCompressor.ts

@@ -382,7 +382,7 @@ export class JsonCompressor {
             i + currentChunk.length - 1
           }]\nPreview: ${chunkString.substring(0, 100)}...\n[Use ${
             this.toolName
-          } tool with key "${key}" to retrieve this chunk]`;
+          } tool with key "${key}" to retrieve this chunk]\n[TIP: try jqToolResponse,grepToolResponse,tailToolResponse to filter/search/map without repeated ${this.toolName} calls - especially useful for JSON data]`;
           finalArray.unshift(stub); // Add stub to the start of our final result.
 
           currentChunk = [];
@@ -415,11 +415,11 @@ export class JsonCompressor {
       
       // Store objects on FIRST occurrence so second occurrence can reference it
       // We increment seenCount above, so after increment:
-      // seenCount=1: first occurrence (just incremented from 0 to 1), store it
-      // seenCount>=2: we already stored it on first occurrence, should be in dedup map
+      // seenCount=0: first occurrence (before increment), store it
+      // seenCount>=1: we already stored it on first occurrence, should be in dedup map
       // Note: This means we store proactively - first occurrence gets stored AND returned in full
       // Second+ occurrences will find it in the dedup map and return a reference
-      const isFirstOccurrence = seenCount === 1;
+      const isFirstOccurrence = seenCount === 0;
 
       // Process the object - apply low-signal detection
       const objWithLowSignalCompressed = this.compressObjectWithLowSignalDetection(obj, path);
@@ -453,7 +453,7 @@ export class JsonCompressor {
           result
         ).join(", ")}\nPreview: ${objectAsString.substring(0, 200)}...\n[Use ${
           this.toolName
-        } tool with key "${key}" to retrieve full content]`;
+        } tool with key "${key}" to retrieve full content]\n[TIP: try jqToolResponse,grepToolResponse,tailToolResponse to filter/search/map without repeated ${this.toolName} calls - especially useful for JSON data]`;
       }
       return result;
     }
@@ -486,7 +486,7 @@ export class JsonCompressor {
           200
         )}...\n[Use ${
           this.toolName
-        } tool with key "${key}" to retrieve full content]`;
+        } tool with key "${key}" to retrieve full content]\n[TIP: try jqToolResponse,grepToolResponse,tailToolResponse to filter/search/map without repeated ${this.toolName} calls - especially useful for JSON data]`;
       }
       return obj;
     }

package/src/services/KnowhowClient.ts

@@ -171,11 +171,9 @@ export class KnowhowSimpleClient {
       try {
         this.jwtValidated = true;
         const response = await this.me();
-
         const user = response.data.user;
         const orgs = user.orgs;
         const orgId = response.data.orgId;
-
         const currentOrg = orgs.find((org) => {
           return org.organizationId === orgId;
         });
@@ -227,6 +225,17 @@ export class KnowhowSimpleClient {
     return presignedUrl;
   }
 
+  async getOrgEmbedding(id: string) {
+    await this.checkJwt();
+    const resp = await http.get(
+      `${this.baseUrl}/api/org-embeddings/${id}`,
+      {
+        headers: this.headers,
+      }
+    );
+    return resp.data as { id: string; modelName: string; name: string; [key: string]: unknown };
+  }
+
   async updateEmbeddingMetadata(
     id: string,
     data: {
@@ -718,6 +727,17 @@ export class KnowhowSimpleClient {
     );
   }
 
+  /**
+   * Get a single cloud worker by ID
+   */
+  async getCloudWorker(id: string) {
+    await this.checkJwt();
+    return http.get<{ id: string; name: string; status: string; workerConfigJson?: Record<string, unknown> }>(
+      `${this.baseUrl}/api/cloud-workers/${id}`,
+      { headers: this.headers }
+    );
+  }
+
   /**
    * Update an existing cloud worker
    */