@tyvm/knowhow 0.0.158 → 0.0.160

package/CONFIG.md

@@ -1,429 +0,0 @@
-
-Here is an overview of examples from various `knowhow.json` configuration files found, illustrating the configuration capabilities that Knowhow supports:
-
----
-
-## General Configuration Template
-
-```json
-{
-  "promptsDir": ".knowhow/prompts",
-  "plugins": [
-    "embeddings",
-    "language",
-    "vim",
-    "github",
-    "asana",
-    "jira",
-    "linear",
-    "download",
-    "figma"
-  ],
-  "sources": [
-    {
-      "input": "src/**/*.mdx",
-      "output": ".knowhow/docs/",
-      "prompt": "BasicCodeDocumenter"
-    }
-  ],
-
-  // Generate embeddings from a series of files on your machine
-  // Remote knowhow with the kb id allows you to leverage knowhow upload
-  "embedSources": [
-    {
-      "input": ".knowhow/docs/**/*.mdx",
-      "output": ".knowhow/embeddings",
-      "chunkSize": 2000,
-      "remoteType": "knowhow",
-      "remoteId": "141d9c4d-1589-4ccc-bf39-031f4259b89f"
-    }
-  ],
-
-  // Define aditional agents you can interact with via chat
-  "agents": [
-    {
-      "name": "linter",
-      "description": "Clean up your code",
-      "instructions": "Read the files that are loaded via vim plugin and provide debugging and linter suggestions"
-    }
-    {
-      "name": "Codebase Helper",
-      "description": "Helps you code",
-      "instructions": "Codebase helper, use files and tools to help us code",
-      "model": "gpt-4-1106-preview",
-      "tools": [
-        {
-          "type": "code_interpreter"
-        }
-      ],
-      "files": [
-        ".knowhow/docs/**/*.mdx"
-      ]
-    }
-  ]
-}
-```
-
-## Video Download Support
-```json
-  "embedSources": [
-    {
-      "input": "https://www.youtube.com/shorts/BYuMBK5Ll-s",
-      "output": ".knowhow/embeddings/video.json",
-      "chunkSize": 2000,
-      "kind": "download"
-    }
-  ],
-```
-
-## MCP Setup
-
-```json
-  "mcps": [
-    {
-      "name": "browser",
-      "command": "npx",
-      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
-    }
-  ],
-```
-
-## Expose Tools to Knowhow Site via workers
-After you've connected via `knowhow login` you can connect tools from your local machine
-Run `knowhow worker` to generate a block like below. Edit it to include the tools you want to expose.
-Then run `knowhow worker` again to connect
-```json
-  "worker": {
-    "allowedTools": [
-      "embeddingSearch",
-      "finalAnswer",
-      "callPlugin",
-      "readFile",
-      "readBlocks",
-      "patchFile",
-      "lintFile",
-      "textSearch",
-      "fileSearch",
-      "writeFileChunk",
-      "createAiCompletion",
-      "listAllModels",
-      "listAllProviders",
-      "getPullRequest",
-      "getPullRequestBuildStatuses",
-      "getRunLogs",
-      "getPullRequestBuildFailureLogs",
-      "addLanguageTerm",
-      "getAllLanguageTerms",
-      "lookupLanguageTerm",
-      "mcp_0_puppeteer_navigate",
-      "mcp_0_puppeteer_screenshot",
-      "mcp_0_puppeteer_click",
-      "mcp_0_puppeteer_fill",
-      "mcp_0_puppeteer_select",
-      "mcp_0_puppeteer_hover",
-      "mcp_0_puppeteer_evaluate"
-    ]
-  },
-```
-
-## Custom Models Via LMS Studio
-```json
-  "modelProviders": [
-    {
-      "url": "http://localhost:1234",
-      "provider": "lms"
-    }
-  ],
-```
-
-## Agent Tasks: rename all video files in a folder
-```
-  "sources": [
-    {
-      "input": ".knowhow/downloads/**/*.webm",
-      "output": ".knowhow/organized/",
-      "prompt": "FSOrganizer",
-      "agent": "Developer"
-    }
-  ],
-```
-
-Prompt Example:
-
-```
-We have this file, we want to generate a nice name for it, please copy the file to .knowhow/org/{better file name}
-
- {text}
-```
-
-## knowhow generate: meeting transcripts
-```json
-  "sources": [
-    {
-      "input": "./meetings/**/*.mov",
-      "output": "./meetings/ai-notes/",
-      "prompt": "MeetingNotes"
-    },
-    {
-      "input": "./meetings/TaskRelatedCall/transcript.txt",
-      "output": "./meetings/tasks/RewardsTasks.txt",
-      "prompt": "AsanaTasks"
-    },
-    {
-      "input": "./meetings/EngineeringCall/transcript.txt",
-      "output": "./meetings/tasks/SchemaChanges.txt",
-      "prompt": "Schema"
-    }
-  ],
-```
-
-
-Use the source block alongside `knowhow generate` to process a pipeline of files, applying prompts to generate documentation or other artifacts. This example demonstrates the configuration for processing meeting recordings, and then running prompts on the resulting transcripts.
-
-I've been using `CMD+SHIFT+5` to record meetings and then using the `sources` block to process the recordings into notes and tasks.
-
-When a .mov or audio file is an input, it will automatically create a transcript.txt in the same directory, so we can leverage that txt input in the next step. The pipeline is useful for apply one or more prompts to one or more input files.
-
-## knowhow embed: documentation embeddings
-```json
-  "embedSources": [
-    {
-      "input": "./documentation/docusaurus/docs/dev-docs/**/*.md",
-      "output": ".knowhow/embeddings/strapi-docs.json",
-      "chunkSize": 2000
-    }
-  ]
-```
-
-## knowhow embed: codebase embeddings
-```json
-
-  "embedSources": [
-    {
-      "input": "./packages/p2p/src/**/*.ts",
-      "output": ".knowhow/embeddings/p2p.json",
-      "chunkSize": 2000
-    },
-    {
-      "input": "./packages/openai_proxy/src/**/*.ts",
-      "output": ".knowhow/embeddings/openai_proxy.json",
-      "chunkSize": 2000
-    },
-    {
-      "input": "./packages/contracts/src/**/*.sol",
-      "output": ".knowhow/embeddings/contracts.json",
-      "chunkSize": 2000
-    }
-  ],
-```
-You can use `knowhow embed` to generate json embeddings from a set of files. If you want to run a prompt on the input, before embedding, you set an optional `prompt` field to match the filename of the prompt stored in your `.knowhow/prompts` directory.
-
-These embeddings are leveraged by the chat in `knowhow chat` or by the agents to accomplish their tasks
-
-## knowhow embed: asana tasks
-```
-  "embedSources": [
-    {
-      "input": "https://app.asana.com/0/111111111111111/list",
-      "output": ".knowhow/embeddings/asana.json",
-      "remote": "mybucket",
-      "remoteType": "s3",
-      "kind": "asana",
-      "chunkSize": 2000
-    }
-  ],
-```
-
-
-Any plugin that implements the embedding function, can generate embeddings if you set the `kind` field to the plugin name. The `remote` field is optional, and if set, the embeddings will be uploaded to the specified S3 bucket via `knowhow upload`.
-
-You can download remote embeddings via `knowhow download` and use them in your local environment.
-
-For downloads we support the following remote options:
-- s3
-- github* - downloads files
-
-For uploads we support the following remote options:
-- s3
-- github* - use git lfs to commit the embeddings to your repository
-
-
-## knowhow embed: github embeddings
-```
-  "embedSources": [
-    {
-      "input": "./src/**/*.ts",
-      "output": ".knowhow/embeddings/knowhow.json",
-      "chunkSize": 2000,
-      "remote": "micahriggan/knowhow",
-      "remoteType": "github"
-    }
-  ],
-```
-Here's an example where you could download embeddings from github. As the code updates occasionally I'll run `knowhow embed` and commit the updated embeddings.
-
-## Plugins
-```json
-{
-  "plugins": [
-    "embeddings",
-    "language",
-    "vim",
-    "github",
-    "asana",
-    "jira",
-    "linear",
-    "download",
-    "figma",
-    "notion"
-  ],
-}
-```
-Plugins are used to resolve urls or other references to data that the AI can use. For example, the `asana` plugin can be used to resolve tasks and projects from Asana, and the `figma` plugin can be used to resolve design files from Figma.
-
-The language plugin allows you to define hotkeys that resolve to larger blocks of texts or files, or urls. For example, you can define a language entry `#asana` that resolves to a link to your current asana task, so that you can easily load that without pasting the link each time.
-
-
-## knowhow chat:
-After generating embeddings, you can use `knowhow chat` to speak with a base agent, that does not have any tools, but does have plugins.
-
-You can use `agent` once you're in a chat to start talking to a Developer agent, that has a prompt and tools designed to help develop software.
-You can use `agents` to see a list of configured agents you can speak with.
-If you need multi-line input you can use `multi` to open a multi-line editor.
-
-There are many commands you can call from a chat session, try TAB to see a list of available options.
-
-
-### knowhow chat: custom agents
-```json
-  "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-4o-2024-08-06",
-      "provider": "openai"
-    }
-  ],
-
-```
-You can configure new agents via the config above. This would create a new option when you use `agents` in a chat session.
-
-## Lint Commands
-
-```json
-{
-  "lintCommands": {
-    "js": "eslint",
-    "ts": "tslint $1 && tsc -p tsconfig.json"
-  }
-}
-```
-lintCommands are automatically run after an agent successfully patches a file, if the file extension matches. So you can configure the AI to receive feedback from tsc and the linter after modifying a TypeScript file. $1 will be replaced with the filepath that was patched.
-
-
-
-## Language Plugin
-
-Configured in `.knowhow/language.json`
-
-Knowhow has a language file, which allows you to define additional context that is included when you use certain phrases in your messages. For instance, you could load a Pull Request when you say "My PR", or load a file from the codebase when you reference it. Languages have "terms" which then load various sources into context. Sources currently can be files, text, or github links.
-
-I primarily use this to define terms like "frontend" or "backend" to load prompt files
-
-## Example Language Definition
-
-```
-{
-  "ui,frontend,component,page": {
-    "sources": [
-      {
-        "data": [
-          "./.knowhow/prompts/frontend.mdx"
-        ],
-        "kind": "file"
-      }
-    ]
-  }
-}
-```
-
-
-Here's and example of having a language term that triggers a plugin.
-This example would load the diff of a PR every time we said "my pr"
-```
-{
-  "knowhow config": {
-    "sources": [
-      {
-        "kind": "file",
-        "data": [
-          ".knowhow/knowhow.json"
-        ]
-      }
-    ]
-  },
-  "My PR": {
-    "sources": [
-      {
-        "kind": "github",
-        "data": [
-          "https://github.com/tyvm-ai/knowhow/pulls/1"
-        ]
-      }
-    ]
-  }
-}
-```
-
-## Language Plugin triggers on file edits
-in  .knowhow/language.json you can trigger event driven language expansions
-```
-  ": any,useState<any[]>": {
-    "events": ["file:post-edit"],
-    "sources": [
-      {
-        "data": [".knowhow/prompts/any.mdx"],
-        "kind": "file"
-      }
-    ]
-  },
-
-  "packages/client/src/generated/*,@tyvm/knowhow-api-client": {
-    "events": ["file:pre-read"],
-    "sources": [
-      {
-        "data": ["./packages/frontend/.knowhow/prompts/ClientHelp.mdx"],
-        "kind": "file"
-      }
-    ]
-  },
-
-  "backend,route,controller,schema,api,server": {
-    "events": ["user:say"],
-    "sources": [
-      {
-        "kind": "file",
-        "data": ["./packages/backend/.knowhow/prompts/backend.mdx"]
-      }
-    ]
-  },
-
-```
-
-## Language Plugin commands
-If you want the language plugin to run a command. Handled: true prevents the ai from seeing this output
-```
-  "/git": {
-    "events": [],
-    "handled": true,
-    "sources": [
-      {
-        "kind": "exec",
-        "data": [
-          "git status"
-        ]
-      }
-    ]
-  },
-```