@tyvm/knowhow 0.0.108 → 0.0.109-dev.86123ed

package/src/commands/misc.ts

@@ -0,0 +1,174 @@
+import { Command } from "commander";
+import { execSync } from "child_process";
+import { version } from "../../package.json";
+import { logger } from "../logger";
+import { generate, embed, upload, download, purge } from "../index";
+import { init } from "../config";
+import { login } from "../login";
+import { KnowhowSimpleClient } from "../services/KnowhowClient";
+import { startChat } from "../chat";
+
+export function addInitCommand(program: Command): void {
+  program
+    .command("init")
+    .description("Initialize knowhow configuration")
+    .action(async () => {
+      await init();
+    });
+}
+
+export function addLoginCommand(program: Command): void {
+  program
+    .command("login")
+    .description("Login to knowhow")
+    .option("--jwt", "Use manual JWT input instead of browser login")
+    .action(async (opts) => {
+      await login(opts.jwt);
+    });
+}
+
+export function addUpdateCommand(program: Command): void {
+  program
+    .command("update")
+    .description("Update knowhow to the latest version from npm")
+    .action(async () => {
+      try {
+        console.log("🔄 Checking for knowhow updates...");
+        console.log(`Current version: ${version}`);
+        console.log("📦 Installing latest version from npm...");
+        execSync("npm install -g @tyvm/knowhow@latest", {
+          stdio: "inherit",
+          encoding: "utf-8",
+        });
+        console.log("✓ knowhow has been updated successfully!");
+        console.log("Run 'knowhow --version' to see the new version.");
+      } catch (error) {
+        console.error("Error updating knowhow:", error.message);
+        process.exit(1);
+      }
+    });
+}
+
+export function addGenerateCommand(program: Command): void {
+  program
+    .command("generate")
+    .description("Generate documentation")
+    .action(async () => {
+      const { setupServices } = await import("./services");
+      await setupServices();
+      await generate();
+    });
+}
+
+export function addEmbedCommands(program: Command): void {
+  program
+    .command("embed")
+    .description("Create embeddings")
+    .action(async () => {
+      const { setupServices } = await import("./services");
+      await setupServices();
+      await embed();
+    });
+
+  program
+    .command("embed:purge")
+    .description("Purge embeddings matching a glob pattern")
+    .argument("<pattern>", "Glob pattern to match files for purging")
+    .action(async (pattern) => {
+      await purge(pattern);
+    });
+}
+
+export function addUploadCommand(program: Command): void {
+  program
+    .command("upload")
+    .description("Upload data")
+    .action(async () => {
+      await upload();
+    });
+}
+
+export function addDownloadCommand(program: Command): void {
+  program
+    .command("download")
+    .description("Download data")
+    .action(async () => {
+      await download();
+    });
+}
+
+export function addChatCommand(program: Command): void {
+  program
+    .command("chat")
+    .description("Start new chat interface")
+    .action(async () => {
+      const { setupServices } = await import("./services");
+      await setupServices();
+      await startChat();
+    });
+}
+
+export function addGithubCredentialsCommand(program: Command): void {
+  program
+    .command("github-credentials [action]")
+    .description(
+      "Git credential helper for GitHub. Use as: git config credential.helper 'knowhow github-credentials'"
+    )
+    .option(
+      "--repo <repo>",
+      "Repository in owner/repo format (e.g. myorg/myrepo)"
+    )
+    .action(async (action: string | undefined, options: { repo?: string }) => {
+      // Silence ALL output immediately — git credential helpers must produce
+      // only the protocol=.../host=.../username=.../password=... lines on stdout.
+      logger.silence();
+
+      const client = new KnowhowSimpleClient();
+
+      let repo = options.repo;
+
+      if (action === "get") {
+        const lines: string[] = [];
+        const readline = await import("readline");
+        const rl = readline.createInterface({
+          input: process.stdin,
+          terminal: false,
+        });
+        await new Promise<void>((resolve) => {
+          rl.on("line", (line) => {
+            if (line.trim()) lines.push(line.trim());
+          });
+          rl.on("close", resolve);
+        });
+      } else if (action === "store" || action === "erase") {
+        process.exit(0);
+      }
+
+      if (!repo) {
+        try {
+          const remoteUrl = execSync("git remote get-url origin", {
+            encoding: "utf-8",
+            stdio: ["pipe", "pipe", "pipe"],
+          }).trim();
+          const match =
+            remoteUrl.match(/github\.com[/:]([^/]+\/[^/]+?)(?:\.git)?$/) ||
+            remoteUrl.match(/github\.com\/([^/]+\/[^/]+)/);
+          if (match) {
+            repo = match[1];
+          }
+        } catch {
+          // Not in a git repo or no remote — proceed without repo
+        }
+      }
+
+      try {
+        const credential = await client.getGitCredential(repo || "");
+        process.stdout.write(
+          `protocol=${credential.protocol}\nhost=${credential.host}\nusername=${credential.username}\npassword=${credential.password}\n`
+        );
+      } catch (error) {
+        console.error("Failed to get git credentials:", error.message);
+        process.exit(1);
+      }
+    });
+}

package/src/commands/modules.ts

@@ -0,0 +1,217 @@
+import { Command } from "commander";
+import { execSync } from "child_process";
+import * as fs from "fs";
+import * as path from "path";
+import * as os from "os";
+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",
+];
+
+/**
+ * Returns the path to the .knowhow directory (used as npm install prefix).
+ * For global: ~/.knowhow
+ * For local:  <cwd>/.knowhow
+ */
+function getKnowhowDir(isGlobal: boolean): string {
+  if (isGlobal) {
+    return path.join(os.homedir(), ".knowhow");
+  }
+  return path.join(process.cwd(), ".knowhow");
+}
+
+/**
+ * Ensures the .knowhow directory has a minimal package.json so
+ * `npm install --prefix` works cleanly without polluting the project root.
+ */
+function ensureKnowhowPackageJson(knowhowDir: string): void {
+  const pkgPath = path.join(knowhowDir, "package.json");
+  if (!fs.existsSync(pkgPath)) {
+    fs.mkdirSync(knowhowDir, { recursive: true });
+    fs.writeFileSync(
+      pkgPath,
+      JSON.stringify({ name: "knowhow-modules", private: true, version: "1.0.0" }, null, 2)
+    );
+  }
+}
+
+/**
+ * Run `npm install --prefix <knowhowDir> <mod>` so that modules land in
+ * .knowhow/node_modules rather than the project's node_modules.
+ */
+function npmInstallToKnowhow(mod: string, knowhowDir: string): void {
+  execSync(`npm install --prefix "${knowhowDir}" ${mod}`, {
+    stdio: "inherit",
+    encoding: "utf-8",
+  });
+}
+
+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 into .knowhow/node_modules"
+    )
+    .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;
+        }
+
+        const knowhowDir = getKnowhowDir(isGlobal);
+        ensureKnowhowPackageJson(knowhowDir);
+
+        // Install packages that are not local file paths
+        for (const mod of toAdd) {
+          if (!mod.startsWith(".") && !mod.startsWith("/")) {
+            console.log(`📦 Installing ${mod}...`);
+            npmInstallToKnowhow(mod, knowhowDir);
+          }
+          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: any) {
+        console.error("Error during modules setup:", error.message ?? error);
+        process.exit(1);
+      }
+    });
+
+  modulesCmd
+    .command("install [module]")
+    .description(
+      "Install a module into .knowhow/node_modules 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 = [];
+
+        const knowhowDir = getKnowhowDir(isGlobal);
+        ensureKnowhowPackageJson(knowhowDir);
+
+        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} into ${knowhowDir}/node_modules...`
+          );
+          for (const mod of installable) {
+            console.log(`  📦 Installing ${mod}...`);
+            npmInstallToKnowhow(mod, knowhowDir);
+            console.log(`  ✅ Installed ${mod}`);
+          }
+          console.log(`\n🎉 All modules installed!`);
+          return;
+        }
+
+        // Install the specified module
+        console.log(`📦 Installing ${moduleName} into ${knowhowDir}/node_modules...`);
+        npmInstallToKnowhow(moduleName, knowhowDir);
+        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: any) {
+        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: any) {
+        console.error("Error listing modules:", error.message ?? error);
+        process.exit(1);
+      }
+    });
+}

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

@@ -74,7 +74,7 @@ const defaultConfig = {
       description:
         "You can define agents in the config. They will have access to all tools.",
       instructions: "Reply to the user saying 'Hello, world!'",
-      model: "gpt-4o-2024-08-06",
+      model: "gpt-5.4-nano",
       provider: "openai",
     },
   ],
@@ -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")) {