@tyvm/knowhow 0.0.159 → 0.0.160

package/src/config.ts

@@ -1,468 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import * as os from "os";
-import gitignoreToGlob from "gitignore-to-glob";
-import { Prompts } from "./prompts";
-import { promisify } from "util";
-import {
-  Config,
-  SourceRef,
-  GenerationSource,
-  EmbedSource,
-  Language,
-  AssistantConfig,
-  Models,
-  EmbeddingModels,
-} from "./types";
-import { mkdir, writeFile, readFile, fileExists } from "./utils";
-import { applyMigrations } from "./migrations";
-
-const defaultConfig = {
-  promptsDir: ".knowhow/prompts",
-  modules: [],
-  plugins: {
-    enabled: [
-      "embeddings",
-      "language",
-      "git",
-      "vim",
-      "github",
-      "asana",
-      "jira",
-      "linear",
-      "download",
-      "figma",
-      "url",
-      "tmux",
-      "agents-md",
-      "exec",
-    ],
-    disabled: [],
-  },
-  lintCommands: {
-    js: "eslint",
-    ts: "tslint",
-  },
-  sources: [
-    {
-      input: "src/**/*.mdx",
-      output: ".knowhow/docs/",
-      prompt: "BasicCodeDocumenter",
-    },
-    {
-      input: ".knowhow/docs/**/*.mdx",
-      output: ".knowhow/docs/README.mdx",
-      prompt: "BasicProjectDocumenter",
-    },
-  ],
-  embedSources: [
-    {
-      input: ".knowhow/docs/**/*.mdx",
-      output: ".knowhow/embeddings/docs.json",
-      prompt: "BasicEmbeddingExplainer",
-      chunkSize: 2000,
-    },
-    {
-      input: "src/**/*.ts",
-      output: ".knowhow/embeddings/code.json",
-      chunkSize: 2000,
-    },
-  ],
-  embeddingModel: EmbeddingModels.openai.EmbeddingAda2,
-
-  agents: [
-    {
-      name: "Example agent",
-      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-5.4-nano",
-      provider: "openai",
-    },
-  ],
-  mcps: [
-    {
-      name: "browser",
-      command: "npx",
-      args: ["-y", "@playwright/mcp@latest", "--browser", "chrome"],
-    },
-  ],
-
-  modelProviders: [
-    { provider: "openai", envKey: "OPENAI_API_KEY" },
-    { provider: "anthropic", envKey: "ANTHROPIC_API_KEY" },
-    { provider: "google", envKey: "GEMINI_API_KEY" },
-    { provider: "xai", envKey: "XAI_API_KEY" },
-    { provider: "knowhow" },
-    { provider: "lms", url: "http://localhost:1234" },
-  ],
-
-  ycmd: {
-    enabled: false,
-    installPath: undefined, // Will default to ~/.knowhow/ycmd
-    port: 0, // 0 for auto-assign
-    logLevel: "info",
-    completionTimeout: 5000,
-  },
-
-  worker: {
-    tunnel: {
-      enabled: false,
-      allowedPorts: [],
-    },
-  },
-
-  activeRemote: "origin",
-  remotes: {
-    origin: {
-      name: "origin",
-      apiUrl: "https://api.knowhow.tyvm.ai",
-      jwtPath: ".knowhow/.jwt",
-    },
-  },
-
-  syncRemote: false,
-} as Config;
-
-const defaultLanguage = {
-  "knowhow config": {
-    events: [],
-    sources: [
-      {
-        kind: "file",
-        data: [".knowhow/knowhow.json"],
-      },
-    ],
-  },
-} as Language;
-
-const globalTemplateFolders = ["prompts", "docs", "embeddings"];
-const globalTemplateFiles = {
-  "knowhow.json": JSON.stringify(defaultConfig, null, 2),
-  "language.json": JSON.stringify(defaultLanguage, null, 2),
-  ".ignore": "",
-  ".hashes.json": "{}",
-  ".jwt": "",
-};
-
-for (const prompt of Prompts) {
-  const promptName = Object.keys(prompt)[0];
-  const fileName = "prompts/" + promptName + ".mdx";
-  globalTemplateFiles[fileName] = prompt[promptName];
-}
-
-function getGlobalConfigDir() {
-  return path.join(os.homedir(), ".knowhow");
-}
-
-async function ensureGlobalConfigDir() {
-  const globalConfigDir = getGlobalConfigDir();
-  await mkdir(globalConfigDir, { recursive: true });
-
-  for (const folder of globalTemplateFolders) {
-    const folderPath = path.join(globalConfigDir, folder);
-    await mkdir(folderPath, { recursive: true });
-    fs.chmodSync(folderPath, 0o744);
-  }
-
-  for (const file of Object.keys(globalTemplateFiles)) {
-    const filePath = path.join(globalConfigDir, file);
-    if (!fs.existsSync(filePath)) {
-      await writeFile(filePath, globalTemplateFiles[file]);
-      fs.chmodSync(filePath, 0o600);
-    }
-  }
-  return globalConfigDir;
-}
-
-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 });
-  for (const folder of globalTemplateFolders) {
-    await mkdir(path.join(".knowhow", folder), { recursive: true });
-  }
-
-  // Copy the template prompts
-  await copyTemplates(globalConfigDir);
-}
-
-export async function getLanguageConfig() {
-  try {
-    if (!fs.existsSync(".knowhow/language.json")) {
-      return {} as Language;
-    }
-
-    const language = JSON.parse(
-      await readFile(".knowhow/language.json", "utf8")
-    );
-    return language as Language;
-  } catch (e) {
-    console.warn("Error reading .knowhow/language.json:", e);
-    return {} as Language;
-  }
-}
-
-export async function updateLanguageConfig(language: Language) {
-  await writeFile(".knowhow/language.json", JSON.stringify(language, null, 2));
-}
-
-export async function updateConfig(config: Config) {
-  if (!config || typeof config !== "object") {
-    throw new Error("Invalid config object");
-  }
-
-  if (fs.existsSync(".knowhow/knowhow.json")) {
-    await fs.promises.copyFile(
-      ".knowhow/knowhow.json",
-      ".knowhow/knowhow.json.bak"
-    );
-  }
-
-  await writeFile(".knowhow/knowhow.json", JSON.stringify(config, null, 2));
-}
-
-async function copyTemplates(globalConfigDir: string) {
-  for (const folder of globalTemplateFolders) {
-    const src = path.join(globalConfigDir, folder);
-    const dest = path.join(".knowhow", folder);
-    // Copy all the template folders, skipping files that already exist
-    await fs.promises.cp(src, dest, {
-      recursive: true,
-      filter: (source, destination) => {
-        return fs.existsSync(dest) ? false : true;
-      },
-    });
-  }
-
-  // Copy the template files, skipping files that already exist
-  for (const file of Object.keys(globalTemplateFiles)) {
-    const src = path.join(globalConfigDir, file);
-    const dest = path.join(".knowhow", file);
-    if (!fs.existsSync(dest)) {
-      await fs.promises.copyFile(src, dest);
-    }
-  }
-}
-
-export function getConfigSync() {
-  try {
-    const config = JSON.parse(
-      fs.readFileSync(".knowhow/knowhow.json", "utf8").toString()
-    );
-    return config as Config;
-  } catch (e) {
-    return {} as Config;
-  }
-}
-
-let loggedWarning = false;
-/**
- * Checks whether an item in a sources/embedSources array is a SourceRef
- * (i.e. `{ from: "..." }`) rather than a real source entry.
- */
-function isSourceRef(item: unknown): item is SourceRef {
-  return (
-    typeof item === "object" &&
-    item !== null &&
-    "from" in item &&
-    typeof (item as any).from === "string"
-  );
-}
-
-/**
- * Resolves `{ from: "./path/to/file.json" }` entries in `sources` and
- * `embedSources` arrays. Each referenced file must contain a JSON array of
- * source entries. Paths are resolved relative to `.knowhow/`.
- */
-function resolveSourceRefs<T>(
-  items: (T | SourceRef)[] | undefined,
-  label: string
-): T[] {
-  if (!items) return [];
-  const resolved: T[] = [];
-  for (const item of items) {
-    if (isSourceRef(item)) {
-      const refPath = path.resolve(".knowhow", item.from);
-      try {
-        const raw = fs.readFileSync(refPath, "utf8");
-        const arr = JSON.parse(raw);
-        if (!Array.isArray(arr)) {
-          console.warn(`⚠️  ${label} ref "${item.from}" did not contain a JSON array — skipping.`);
-          continue;
-        }
-        resolved.push(...(arr as T[]));
-      } catch (e) {
-        console.warn(`⚠️  Could not load ${label} ref "${item.from}": ${(e as Error).message}`);
-      }
-    } else {
-      resolved.push(item as T);
-    }
-  }
-  return resolved;
-}
-
-export async function getConfig() {
-  if (!fs.existsSync(".knowhow/knowhow.json")) {
-    if (!loggedWarning) {
-      loggedWarning = true;
-      const warnNeeds = process.env.KNOWHOW_WARN_NEEDS ?? "";
-      const shouldWarn = warnNeeds.split(",").includes("config");
-      if (shouldWarn && !process.argv.includes("init")) {
-        console.warn(
-          "KnowHow config file not found. Please run `knowhow init` to create it."
-        );
-      }
-    }
-    return {} as Config;
-  }
-  try {
-    const config = await readFile(".knowhow/knowhow.json", "utf8");
-    const parsedConfig = JSON.parse(config);
-    // Resolve any { from: "..." } SourceRef entries in sources / embedSources
-    parsedConfig.sources = resolveSourceRefs<GenerationSource>(parsedConfig.sources, "sources");
-    parsedConfig.embedSources = resolveSourceRefs<EmbedSource>(parsedConfig.embedSources, "embedSources");
-    return parsedConfig as Config;
-  } catch (error) {
-    console.error("Error reading .knowhow/knowhow.json:", error);
-    throw new Error("Failed to load KnowHow configuration.");
-  }
-}
-
-export async function getGlobalConfig(): Promise<Config> {
-  const globalConfigDir = getGlobalConfigDir();
-  const globalConfigPath = path.join(globalConfigDir, "knowhow.json");
-  if (!fs.existsSync(globalConfigPath)) {
-    return {} as Config;
-  }
-  try {
-    const config = await readFile(globalConfigPath, "utf8");
-    return JSON.parse(config) as Config;
-  } catch (error) {
-    console.warn("Failed to load global knowhow config:", error);
-    return {} as 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")) {
-    // no config to migrate
-    return;
-  }
-  const parsedConfig = await getConfig();
-  const { modified, config: migratedConfig } = applyMigrations(parsedConfig);
-
-  // After migrations, check if any plugins from defaultConfig are missing
-  let configModified = modified;
-  if (migratedConfig.plugins) {
-    const enabled = migratedConfig.plugins.enabled || [];
-    const disabled = migratedConfig.plugins.disabled || [];
-    const missingPlugins = defaultConfig.plugins.enabled.filter(
-      (plugin) => !enabled.includes(plugin) && !disabled.includes(plugin)
-    );
-
-    if (missingPlugins.length > 0) {
-      console.log(
-        `Adding missing plugins to enabled list: ${missingPlugins.join(", ")}`
-      );
-      migratedConfig.plugins.enabled = [...enabled, ...missingPlugins];
-      configModified = true;
-    }
-  }
-
-  // If migrations were applied, save the updated config
-  if (configModified) {
-    await updateConfig(migratedConfig);
-  }
-}
-
-export async function loadPrompt(promptName: string) {
-  const config = await getConfig();
-  if (!promptName) {
-    return "";
-  }
-
-  const promptsDir = config.promptsDir || ".knowhow/prompts";
-
-  // Try to find the prompt as a file in promptsDir (with .mdx extension)
-  const promptFilePath = path.join(promptsDir, `${promptName}.mdx`);
-  if (fs.existsSync(promptFilePath)) {
-    const prompt = await readFile(promptFilePath, "utf8");
-    return ensureTextPlaceholder(prompt);
-  }
-
-  // Try as a direct file path (in case promptName is a path or has its own extension)
-  if (fs.existsSync(promptName)) {
-    const prompt = await readFile(promptName, "utf8");
-    return ensureTextPlaceholder(prompt);
-  }
-
-  // Otherwise treat promptName itself as the prompt string
-  return ensureTextPlaceholder(promptName);
-}
-
-/**
- * Ensures that the prompt contains a {text} placeholder.
- * If it doesn't, appends \n\n{text} to the end so that
- * the input text is included when the prompt is rendered.
- */
-function ensureTextPlaceholder(prompt: string): string {
-  if (!prompt.includes("{text}")) {
-    return `${prompt}\n\n{text}`;
-  }
-  return prompt;
-}
-
-export async function getIgnorePattern() {
-  const ignoreList = new Array<string>();
-  const gitIgnore = await fileExists(".gitignore");
-  if (gitIgnore) {
-    ignoreList.push(...gitignoreToGlob(".gitignore"));
-  }
-  const knowhowIgnore = await fileExists(".knowhow/.ignore");
-  if (knowhowIgnore) {
-    ignoreList.push(...gitignoreToGlob(".knowhow/.ignore"));
-  }
-  return ignoreList.map((pattern) => pattern.replace("!", "./"));
-}

package/src/conversion.ts

@@ -1,69 +0,0 @@
-import * as path from "path";
-import { readFile, fileExists } from "./utils";
-
-/**
- * Get services lazily to avoid circular dependency issues.
- */
-function getServices() {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const { services } = require("./services") as typeof import("./services");
-  return services();
-}
-
-function getMediaProcessor() {
-  return getServices().MediaProcessor;
-}
-
-export async function processAudio(
-  filePath: string,
-  reusePreviousTranscript = true,
-  chunkTime = 30
-): Promise<string[]> {
-  const parsed = path.parse(filePath);
-  const outputPath = `${parsed.dir}/${parsed.name}/transcript.json`;
-
-  const exists = await fileExists(outputPath);
-  if (exists && reusePreviousTranscript) {
-    console.log(`Transcription ${outputPath} already exists, skipping`);
-    const fileContent = await readFile(outputPath, "utf8");
-    return outputPath.endsWith("txt")
-      ? (fileContent as string).split("\n")
-      : JSON.parse(fileContent as string);
-  }
-
-  const mediaProcessor = getMediaProcessor();
-  return mediaProcessor.processAudio(filePath, reusePreviousTranscript, chunkTime);
-}
-
-export async function convertAudioToText(
-  filePath: string,
-  reusePreviousTranscript = true,
-  chunkTime = 30
-): Promise<string> {
-  const audios = await processAudio(filePath, reusePreviousTranscript, chunkTime);
-
-  let fullString = "";
-  for (let i = 0; i < audios.length; i++) {
-    const audio = audios[i];
-    fullString += `[${i * chunkTime}:${(i + 1) * chunkTime}s] ${audio}`;
-  }
-
-  return fullString;
-}
-
-export async function processVideo(
-  filePath: string,
-  reusePreviousTranscript = true,
-  chunkTime = 30
-): Promise<string[]> {
-  console.log("Processing audio...");
-  const transcriptions = await processAudio(filePath, reusePreviousTranscript, chunkTime);
-  return transcriptions;
-}
-
-/**
- * Thin compat shim — delegates to ConversionService.
- */
-export async function convertToText(filePath: string): Promise<string> {
-  return getServices().Conversion.convertToText(filePath);
-}

package/src/dataset/diffs/README.md

@@ -1,12 +0,0 @@
-# Goal
-The purpose of this folder is to collect examples of file modifications to fine tune GPT
-
-The dataset should be a JSON reprensentation of a chat thread, where the user has requested some modification to a file, and then a before file and after file contents, which will be fed into the createPatchFile function of the diff tool
-
-The function that generates this structure should be generic so that you can fine tune using examples generated from any selected files in the codebase
-
-## Procedure for generating dataset
-- use glob to list out files that would be in the embeddings
-- for each file, get the commit hash via git log --pretty=oneline -- filepath
-- for each file diff the current text against a git show commit:filepath, so that we can generate a diff of all the previous changes
-- summarize the diff with GPT and have it construct a synthetic user message that would be requesting it to modify the file in those ways

package/src/dataset/diffs/debug-errors.ts

@@ -1,29 +0,0 @@
-import "source-map-support/register";
-
-import { parsePatch, diffLines, applyPatch } from "diff";
-import { PatchingAgent } from "../../agents/patcher/patcher";
-import { ask, writeFile, mkdir, readFile } from "../../utils";
-import { fixPatch, parseHunks } from "../../agents/tools/patch";
-
-async function debugFailure() {
-  const errors = [];
-  for (const data of errors) {
-    try {
-      const { fileContent, fixedPatch, originalPatch } = data;
-      const newFixedPatch = fixPatch(fileContent, originalPatch);
-      console.log({ originalPatch, newFixedPatch });
-      const updatedContent = applyPatch(fileContent, newFixedPatch);
-      console.log("DID PATCH APPLY?", !!updatedContent);
-
-      await ask("See output? ");
-      console.log(updatedContent);
-      await ask("Continue? ");
-    } catch (e) {
-      console.log(e);
-    }
-  }
-}
-
-if (require.main === module) {
-  debugFailure();
-}

package/src/dataset/diffs/debug.ts

@@ -1,64 +0,0 @@
-import "source-map-support/register";
-
-import {
-  ChatCompletionMessageParam,
-  ChatCompletionToolMessageParam,
-  ChatCompletionMessageToolCall,
-} from "openai/resources/chat";
-import { parsePatch, diffLines, applyPatch } from "diff";
-import { PatchingAgent } from "../../agents/patcher/patcher";
-import { ask, writeFile, mkdir, readFile } from "../../utils";
-import { fixPatch, parseHunks } from "../../agents/tools/patch";
-import { md5Hash } from "../../hashes";
-
-async function debugFailure() {
-  const successCount = 0;
-  const attempts = 0;
-  const testHash = "40eda1dc8f1e3052997f2930ae59fed2";
-  const dataset = [];
-
-  let patchData;
-  for (const data of dataset) {
-    if ((await md5Hash(data.patch)) === testHash) {
-      patchData = data;
-      break;
-    }
-  }
-
-  if (patchData) {
-    const originalContent = patchData.before;
-    const dirName = `./src/dataset/diffs/test_files/fail/${testHash}`;
-    const patch = await readFile(`${dirName}/ai-patch.diff`, "utf-8");
-    const fixedPatch = fixPatch(patchData.before, patch);
-    await writeFile(`${dirName}/ai-fixed-patch.diff`, fixedPatch);
-
-    const updatedContent = applyPatch(originalContent, fixedPatch);
-    console.log({ updatedContent });
-    const success = !!updatedContent;
-
-    if (updatedContent === patchData.after || fixedPatch === patchData.patch) {
-      console.log("SUCCESS");
-      console.log("EXACT MATCH");
-    } else {
-      console.log("AI SUGGESTED");
-      console.log(patch);
-
-      console.log("FIXED PATCH");
-      console.log(fixedPatch);
-
-      console.log("ACTUAL");
-      console.log(patchData.patch);
-
-      console.log("DID PATCH APPLY?", !!updatedContent);
-    }
-  }
-
-  const parsedAnswer = parsePatch(patchData.patch);
-  const fileName = parsedAnswer[0].oldFileName;
-
-  console.log({ successCount, attempts, total: dataset.length });
-}
-
-if (require.main === module) {
-  debugFailure();
-}