Open source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base
update repo url
Hugo Richardbf4489b43809
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.ymlindex 726ea85..82a8944 100644--- a/.github/ISSUE_TEMPLATE/bug-report.yml+++ b/.github/ISSUE_TEMPLATE/bug-report.yml@@ -5,7 +5,7 @@ body:- type: markdownattributes:value: |- Before reporting a bug, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues) to see if the bug has already been reported or fixed. If it has, please add your reaction to the existing issue instead of creating a new one.+ Before reporting a bug, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/knowledge-agent-template/issues) to see if the bug has already been reported or fixed. If it has, please add your reaction to the existing issue instead of creating a new one.- type: textareaid: envattributes:diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.ymlindex b8b8f73..5e35cbb 100644--- a/.github/ISSUE_TEMPLATE/config.yml+++ b/.github/ISSUE_TEMPLATE/config.yml@@ -1,5 +1,5 @@blank_issues_enabled: truecontact_links:- name: GitHub Discussions- url: https://github.com/vercel-labs/chatsdk-knowledge-agent-template/discussions+ url: https://github.com/vercel-labs/knowledge-agent-template/discussionsabout: Ask questions and discuss ideas with the communitydiff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.ymlindex 1a25f16..f81888b 100644--- a/.github/ISSUE_TEMPLATE/feature-request.yml+++ b/.github/ISSUE_TEMPLATE/feature-request.yml@@ -5,7 +5,7 @@ body:- type: markdownattributes:value: |- Before requesting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues) to see if the feature has already been requested or implemented. If it has, please add your reaction to the existing issue instead of creating a new one.+ Before requesting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/knowledge-agent-template/issues) to see if the feature has already been requested or implemented. If it has, please add your reaction to the existing issue instead of creating a new one.- type: textareaid: descriptionattributes:diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.ymlindex d9d431a..d70a3cd 100644--- a/.github/ISSUE_TEMPLATE/question.yml+++ b/.github/ISSUE_TEMPLATE/question.yml@@ -5,7 +5,7 @@ body:- type: markdownattributes:value: |- Before requesting a question, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues) to see if the feature has already been requested or implemented. If it has, please add your reaction to the existing issue instead of creating a new one.+ Before requesting a question, please make sure that you have read through our documentation and existing [issues](https://github.com/vercel-labs/knowledge-agent-template/issues) to see if the feature has already been requested or implemented. If it has, please add your reaction to the existing issue instead of creating a new one.- type: textareaid: descriptionattributes:diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 5ff9ce1..2a1efdf 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -4,13 +4,13 @@ Thank you for your interest in contributing to Knowledge Agent Template!## Reporting Bugs-- Search [existing issues](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues) before opening a new one+- Search [existing issues](https://github.com/vercel-labs/knowledge-agent-template/issues) before opening a new one- Include steps to reproduce, expected behavior, and actual behavior- Include your environment (Node version, OS, browser)## Suggesting Features-- Open a [feature request issue](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues/new)+- Open a [feature request issue](https://github.com/vercel-labs/knowledge-agent-template/issues/new)- Describe the use case and why it would be valuable- If possible, outline a proposed implementation@@ -18,8 +18,8 @@ Thank you for your interest in contributing to Knowledge Agent Template!```bash# Clone the repo-git clone https://github.com/vercel-labs/chatsdk-knowledge-agent-template.git-cd chatsdk-knowledge-agent-template+git clone https://github.com/vercel-labs/knowledge-agent-template.git+cd knowledge-agent-template# Install dependenciesbun installdiff --git a/README.md b/README.mdindex 8d442b1..3440850 100644--- a/README.md+++ b/README.md@@ -14,7 +14,7 @@</p><p align="center">- <a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=Required%20environment%20variables.%20See%20docs%2FENVIRONMENT.md%20for%20details.&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent"><img src="https://vercel.com/button" alt="Deploy with Vercel" /></a>+ <a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=BETTER_AUTH_SECRET%3A%20run%20openssl%20rand%20-hex%2032%20%7C%20GITHUB_CLIENT_ID%20%2B%20SECRET%3A%20create%20a%20GitHub%20App%20at%20github.com%2Fsettings%2Fapps%2Fnew%20%7C%20AI_GATEWAY_API_KEY%3A%20create%20a%20gateway%20at%20vercel.com%2F~%2Fai&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent"><img src="https://vercel.com/button" alt="Deploy with Vercel" /></a></p>---@@ -120,14 +120,14 @@ console.log(text)### Deploy to Vercel-[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=Required%20environment%20variables.%20See%20docs%2FENVIRONMENT.md%20for%20details.&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent)+[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=BETTER_AUTH_SECRET%3A%20run%20openssl%20rand%20-hex%2032%20%7C%20GITHUB_CLIENT_ID%20%2B%20SECRET%3A%20create%20a%20GitHub%20App%20at%20github.com%2Fsettings%2Fapps%2Fnew%20%7C%20AI_GATEWAY_API_KEY%3A%20create%20a%20gateway%20at%20vercel.com%2F~%2Fai&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent)### Self-hosting```bash# Clone the repository-git clone https://github.com/vercel-labs/chatsdk-knowledge-agent-template.git-cd chatsdk-knowledge-agent-template+git clone https://github.com/vercel-labs/knowledge-agent-template.git+cd knowledge-agent-template# Install dependenciesbun installdiff --git a/apps/app/app/app.config.ts b/apps/app/app/app.config.tsindex a8f4b21..3743eed 100644--- a/apps/app/app/app.config.ts+++ b/apps/app/app/app.config.ts@@ -3,8 +3,8 @@ export default defineAppConfig({name: 'Knowledge Agent Template',description: 'Open source file-system and knowledge based agent template.',icon: 'i-simple-icons-vercel',- repoUrl: 'https://github.com/vercel-labs/chatsdk-knowledge-agent-template',- deployUrl: 'https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=Required%20environment%20variables.%20See%20docs%2FENVIRONMENT.md%20for%20details.&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fchatsdk-knowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent',+ repoUrl: 'https://github.com/vercel-labs/knowledge-agent-template',+ deployUrl: 'https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template&env=BETTER_AUTH_SECRET,GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,AI_GATEWAY_API_KEY&envDescription=BETTER_AUTH_SECRET%3A%20run%20openssl%20rand%20-hex%2032%20%7C%20GITHUB_CLIENT_ID%20%2B%20SECRET%3A%20create%20a%20GitHub%20App%20at%20github.com%2Fsettings%2Fapps%2Fnew%20%7C%20AI_GATEWAY_API_KEY%3A%20create%20a%20gateway%20at%20vercel.com%2F~%2Fai&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fknowledge-agent-template%2Fblob%2Fmain%2Fdocs%2FENVIRONMENT.md&project-name=knowledge-agent&repository-name=knowledge-agent',},ui: {colors: {diff --git a/apps/app/app/content/docs/admin-mode.md b/apps/app/app/content/docs/admin-mode.mdindex febd8a2..2d36db1 100644--- a/apps/app/app/content/docs/admin-mode.md+++ b/apps/app/app/content/docs/admin-mode.md@@ -78,4 +78,4 @@ Admin mode uses a completely separate AI pipeline from the regular chat:Admin chats are stored like regular chats but tagged with `mode: 'admin'` in the database.-For a deeper look at the architecture behind admin mode and other components, see the [Architecture documentation](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub.+For a deeper look at the architecture behind admin mode and other components, see the [Architecture documentation](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub.diff --git a/apps/app/app/content/docs/bot-setup.md b/apps/app/app/content/docs/bot-setup.mdindex 26019e7..2b947dc 100644--- a/apps/app/app/content/docs/bot-setup.md+++ b/apps/app/app/content/docs/bot-setup.md@@ -87,4 +87,4 @@ When enabled, the bot will respond to every new issue opened in repositories wheThe bot is built on the [Vercel Chat SDK](https://github.com/vercel-labs/chat) with a custom GitHub adapter. It uses the [Octokit](https://github.com/octokit/rest.js) library with [GitHub App authentication](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app) to interact with the GitHub API.-Each response goes through the same AI agent pipeline as the chat interface, using [Vercel AI SDK](https://ai-sdk.dev) tools to search the knowledge base in a [Vercel Sandbox](https://vercel.com/docs/vercel-sandbox). For the full architecture, see the [Architecture documentation](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub. To build your own adapter, see the [Customization Guide](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/CUSTOMIZATION.md#4-add-a-bot-adapter).+Each response goes through the same AI agent pipeline as the chat interface, using [Vercel AI SDK](https://ai-sdk.dev) tools to search the knowledge base in a [Vercel Sandbox](https://vercel.com/docs/vercel-sandbox). For the full architecture, see the [Architecture documentation](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub. To build your own adapter, see the [Customization Guide](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/CUSTOMIZATION.md#4-add-a-bot-adapter).diff --git a/apps/app/app/content/docs/discord-bot.md b/apps/app/app/content/docs/discord-bot.mdindex b7d27d9..132f24f 100644--- a/apps/app/app/content/docs/discord-bot.md+++ b/apps/app/app/content/docs/discord-bot.md@@ -70,4 +70,4 @@ Bot conversation state is stored in:- [**Redis**](https://upstash.com/docs/redis) if `REDIS_URL` is set (recommended for production -- state persists across restarts)- **In-memory** as fallback (state is lost on restart)-For the full architecture and how to build custom adapters, see the [Architecture](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) and [Customization Guide](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/CUSTOMIZATION.md#4-add-a-bot-adapter) on GitHub.+For the full architecture and how to build custom adapters, see the [Architecture](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) and [Customization Guide](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/CUSTOMIZATION.md#4-add-a-bot-adapter) on GitHub.diff --git a/apps/app/app/content/docs/getting-started.md b/apps/app/app/content/docs/getting-started.mdindex c1db232..6474231 100644--- a/apps/app/app/content/docs/getting-started.md+++ b/apps/app/app/content/docs/getting-started.md@@ -135,7 +135,7 @@ The app will be available at `http://localhost:3000`. The first user to sign up## Adding Sources-Sources define the knowledge base the app uses to answer questions. They are managed through the **admin interface**. Sources aren't limited to documentation — you can add any content that produces files (GitHub repos, YouTube transcripts, custom APIs). See the [Sources documentation](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/SOURCES.md) for all available options.+Sources define the knowledge base the app uses to answer questions. They are managed through the **admin interface**. Sources aren't limited to documentation — you can add any content that produces files (GitHub repos, YouTube transcripts, custom APIs). See the [Sources documentation](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/SOURCES.md) for all available options.1. Navigate to the admin panel at `/admin`2. Go to the Sources section@@ -152,7 +152,7 @@ After adding or updating sources, trigger a sync from the admin interface. The s4. Pushes changes to the snapshot repository5. Takes a new sandbox snapshot for instant startup-> **Note:** Only documentation files are synced. Source code (`.ts`, `.js`, `.vue`, etc.), images, and binaries are automatically excluded. See the [Sources documentation](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/SOURCES.md#content-normalization) for details.+> **Note:** Only documentation files are synced. Source code (`.ts`, `.js`, `.vue`, etc.), images, and binaries are automatically excluded. See the [Sources documentation](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/SOURCES.md#content-normalization) for details.## How It Works@@ -163,7 +163,7 @@ Knowledge Agent Template uses a **file-based search** approach -- no embeddings3. The AI agent uses `bash` and `bash_batch` tools (via the [AI SDK](https://ai-sdk.dev)) to run `grep`, `find`, `cat`, etc. in the sandbox4. Results are synthesized into a natural language answer with citations-You can also integrate the app into your own applications using the [SDK](/admin/docs/sdk). For the full technical architecture, see the [Architecture documentation](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub.+You can also integrate the app into your own applications using the [SDK](/admin/docs/sdk). For the full technical architecture, see the [Architecture documentation](https://github.com/vercel-labs/knowledge-agent-template/blob/main/docs/ARCHITECTURE.md) on GitHub.## Admin Paneldiff --git a/apps/app/app/content/docs/sdk.md b/apps/app/app/content/docs/sdk.mdindex 1b89273..9ffd77f 100644--- a/apps/app/app/content/docs/sdk.md+++ b/apps/app/app/content/docs/sdk.md@@ -1,6 +1,6 @@# Knowledge Agent Template SDK-The [`@savoir/sdk`](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/tree/main/packages/sdk) package provides a TypeScript client for interacting with Knowledge Agent Template programmatically. It exposes [AI SDK](https://ai-sdk.dev)-compatible tools that let any AI model search and read your knowledge base. For the full API reference and error handling, see the [SDK README](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/packages/sdk/README.md) on GitHub.+The [`@savoir/sdk`](https://github.com/vercel-labs/knowledge-agent-template/tree/main/packages/sdk) package provides a TypeScript client for interacting with Knowledge Agent Template programmatically. It exposes [AI SDK](https://ai-sdk.dev)-compatible tools that let any AI model search and read your knowledge base. For the full API reference and error handling, see the [SDK README](https://github.com/vercel-labs/knowledge-agent-template/blob/main/packages/sdk/README.md) on GitHub.## Installationdiff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.mdindex fd088db..df11912 100644--- a/docs/ENVIRONMENT.md+++ b/docs/ENVIRONMENT.md@@ -43,7 +43,7 @@ GitHub OAuth credentials for user login. You need a **GitHub App** (not an OAuth- Copy the **Client ID** → `GITHUB_CLIENT_ID`- Click **Generate a new client secret** → `GITHUB_CLIENT_SECRET`-> See the [Getting Started guide](https://github.com/vercel-labs/chatsdk-knowledge-agent-template/blob/main/apps/app/app/content/docs/getting-started.md#github-app-setup) for the full GitHub App setup with bot permissions.+> See the [Getting Started guide](https://github.com/vercel-labs/knowledge-agent-template/blob/main/apps/app/app/content/docs/getting-started.md#github-app-setup) for the full GitHub App setup with bot permissions.### `NUXT_SESSION_PASSWORD` (optional)diff --git a/package.json b/package.jsonindex 9e494e4..444f979 100644--- a/package.json+++ b/package.json@@ -7,10 +7,10 @@"author": "HugoRCD","repository": {"type": "git",- "url": "git+https://github.com/vercel-labs/chatsdk-knowledge-agent-template.git"+ "url": "git+https://github.com/vercel-labs/knowledge-agent-template.git"},"bugs": {- "url": "https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues"+ "url": "https://github.com/vercel-labs/knowledge-agent-template/issues"},"workspaces": ["apps/*",diff --git a/packages/agent/package.json b/packages/agent/package.jsonindex 77288ae..70051b9 100644--- a/packages/agent/package.json+++ b/packages/agent/package.json@@ -5,13 +5,13 @@"description": "Framework-agnostic agent core for Knowledge Agent Template","repository": {"type": "git",- "url": "git+https://github.com/vercel-labs/chatsdk-knowledge-agent-template.git",+ "url": "git+https://github.com/vercel-labs/knowledge-agent-template.git","directory": "packages/agent"},"bugs": {- "url": "https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues"+ "url": "https://github.com/vercel-labs/knowledge-agent-template/issues"},- "homepage": "https://github.com/vercel-labs/chatsdk-knowledge-agent-template/tree/main/packages/agent#readme",+ "homepage": "https://github.com/vercel-labs/knowledge-agent-template/tree/main/packages/agent#readme","type": "module","exports": {".": {diff --git a/packages/sdk/README.md b/packages/sdk/README.mdindex 9af8996..16b1f1b 100644--- a/packages/sdk/README.md+++ b/packages/sdk/README.md@@ -1,6 +1,6 @@# @savoir/sdk-SDK for [Knowledge Agent Template](https://github.com/vercel-labs/chatsdk-knowledge-agent-template) — AI agents with up-to-date knowledge base access.+SDK for [Knowledge Agent Template](https://github.com/vercel-labs/knowledge-agent-template) — AI agents with up-to-date knowledge base access.Provides [AI SDK](https://ai-sdk.dev) compatible tools to query content in a sandboxed environment.diff --git a/packages/sdk/package.json b/packages/sdk/package.jsonindex e2ef0f9..d4e4611 100644--- a/packages/sdk/package.json+++ b/packages/sdk/package.json@@ -6,12 +6,12 @@"author": "Hugo Richard","repository": {"type": "git",- "url": "git+https://github.com/vercel-labs/chatsdk-knowledge-agent-template.git",+ "url": "git+https://github.com/vercel-labs/knowledge-agent-template.git","directory": "packages/sdk"},- "homepage": "https://github.com/vercel-labs/chatsdk-knowledge-agent-template/tree/main/packages/sdk#readme",+ "homepage": "https://github.com/vercel-labs/knowledge-agent-template/tree/main/packages/sdk#readme","bugs": {- "url": "https://github.com/vercel-labs/chatsdk-knowledge-agent-template/issues"+ "url": "https://github.com/vercel-labs/knowledge-agent-template/issues"},"keywords": ["savoir",