# Notochord

本地优先的 AI 工作台：把重复的工作封装成可安装、可审计的 Gem，交给 AI 反复执行。

> 本站每个页面都是一个 Markdown 文件：下面的链接直接返回原文，浏览器打开则由一小段脚本渲染。

## 简体中文 (zh)

### 首页
- [你的私人 AI 团队](https://www.notochord.ai/zh/index.md): Notochord 是一个本地优先、将以 MIT 协议开源的桌面 AI 工作台：安装简单、沙盒安全、密钥不出本机、数据不上云，模型任你选，工作流可复用可分享。

### 下载
- [下载](https://www.notochord.ai/zh/download.md): Notochord 正在开发中，暂未提供安装包；之后将以 MIT 协议开源发布。

### 使用文档
- [文档概览](https://www.notochord.ai/zh/guide/index.md): Notochord 使用文档的入口，按「装上 → 跑起来 → 用好」的顺序排列。
- [五分钟上手](https://www.notochord.ai/zh/guide/quickstart.md): 首次设置（语言、数据加密、模型、角色），然后建第一个项目、开始第一次对话。
- [用项目组织工作](https://www.notochord.ai/zh/guide/projects.md): 项目把一件事的表格、页面、文件和对话放在一起：工作视图、构建视图，以及把项目发布成 gem。
- [对话与会话](https://www.notochord.ai/zh/guide/chat.md): 会话管理、附件、工具调用记录与权限弹窗。
- [配置模型](https://www.notochord.ai/zh/guide/models.md): 接入 OpenAI、Anthropic、Gemini、OpenRouter、Ollama，以及本地 GGUF 离线模型；角色怎么设、AI 怎么用它们；应用在哪些地方会调用你的模型。
- [Gem：安装与使用](https://www.notochord.ai/zh/guide/gems.md): 从商店安装 Gem、在它的页面上设置、查看它做了什么、卸载。
- [凭据与连接](https://www.notochord.ai/zh/guide/credentials.md): API Key 和账号怎么保存，AI 与 Gem 怎么在拿不到明文的前提下使用它们。
- [组织](https://www.notochord.ai/zh/guide/organizations.md): 用多个组织把工作和个人数据彻底分开：各自存放什么、如何切换、删除意味着什么。
- [设置项说明](https://www.notochord.ai/zh/guide/settings.md): 逐项说明设置面板中的选项。
- [常见问题](https://www.notochord.ai/zh/guide/faq.md): 数据、模型、gem 与权限相关的常见问题。

### 开发者文档
- [开发者文档](https://www.notochord.ai/zh/dev/index.md): 编写、调试、打包与发布 Notochord Gem 的完整参考。
- [Gem 是什么](https://www.notochord.ai/zh/dev/gem-overview.md): Gem 的目录结构、生命周期，以及它和会话、Agent 的关系。
- [清单参考](https://www.notochord.ai/zh/dev/manifest.md): manifest 每个字段的含义、取值与校验规则。
- [权限模型](https://www.notochord.ai/zh/dev/permissions.md): 网络和知识库等权限的申请方式与安装时校验；gem 自己的存储、文件和文件夹、文档抽取不用申请。
- [数据与存储](https://www.notochord.ai/zh/dev/storage.md): Gem 自己的数据：在清单里声明集合，用 ctx.data 读写记录、Log、文档和 Blob；查询与索引、事务、版本迁移、Gem Studio 测试、加密与上限。
- [知识库 API](https://www.notochord.ai/zh/dev/knowledge.md): Gem 通过 ctx.knowledge 读写用户知识库：概念、权限字符串、完整 API、写入规则与卸载行为。
- [工具 API](https://www.notochord.ai/zh/dev/tools.md): 内置工具清单与自定义工具的定义方式。
- [事件与触发](https://www.notochord.ai/zh/dev/events.md): Gem 的流程（SOP）在什么时候开始运行：手动调用、定时、平台事件三种触发方式的写法、输入、限制和排查方法。
- [本地开发与调试](https://www.notochord.ai/zh/dev/local-dev.md): 用 Gem Studio 起草、测试 gem，并安装到自己的机器上。
- [打包与发布](https://www.notochord.ai/zh/dev/publishing.md): 安装包的组成、安装时和装好以后的校验、签名与信任级别，以及目前能用的分发方式。

## English (en)

### Home
- [Your private AI team](https://www.notochord.ai/en/index.md): Notochord is a local-first desktop AI workspace, to be released as open source under the MIT license — easy to install, sandboxed by default, with your keys and data staying on your machine. Pick any model, build reusable workflows, share them with anyone.

### Download
- [Download](https://www.notochord.ai/en/download.md): Notochord is under development and has no installer yet; it will be released as open source under the MIT license.

### Guide
- [Guide overview](https://www.notochord.ai/en/guide/index.md): The entry point to the Notochord user guide, in the order "install → get running → use it well".
- [Quickstart](https://www.notochord.ai/en/guide/quickstart.md): First-run setup (language, data encryption, models, roles), then create your first project and start your first conversation.
- [Organize Work with Projects](https://www.notochord.ai/en/guide/projects.md): A project keeps the tables, pages, files, and conversations for one piece of work together: the Work view, the Build view, and publishing a project as a gem.
- [Chats and sessions](https://www.notochord.ai/en/guide/chat.md): Managing sessions, attachments, tool-call records, and permission prompts.
- [Configure Models](https://www.notochord.ai/en/guide/models.md): Connect OpenAI, Anthropic, Gemini, OpenRouter, Ollama, and local offline GGUF models; how to set roles and how the AI uses them; where the app calls your models.
- [Gems: installing and using them](https://www.notochord.ai/en/guide/gems.md): Install a Gem from the store, set it up on its page, see what it did, and uninstall it.
- [Credentials and connections](https://www.notochord.ai/en/guide/credentials.md): How API keys and accounts are stored, and how the AI and gems use them without ever seeing the plaintext.
- [Organizations](https://www.notochord.ai/en/guide/organizations.md): Use multiple organizations to keep work and personal data completely apart: what each one stores, how to switch, and what deleting means.
- [Settings Reference](https://www.notochord.ai/en/guide/settings.md): An item-by-item explanation of the options in the Settings panel.
- [FAQ](https://www.notochord.ai/en/guide/faq.md): Common questions about data, models, gems, and permissions.

### Developers
- [Developer docs](https://www.notochord.ai/en/dev/index.md): The full reference for writing, debugging, packaging, and publishing Notochord Gems.
- [What a Gem Is](https://www.notochord.ai/en/dev/gem-overview.md): A gem's directory layout and lifecycle, and how it relates to conversations and agents.
- [Manifest reference](https://www.notochord.ai/en/dev/manifest.md): What every manifest field means, the values it accepts, and the validation rules.
- [Permission Model](https://www.notochord.ai/en/dev/permissions.md): How network and knowledge-base permissions are requested and checked at install time; a gem's own storage, files and folders, and document extraction need no permission.
- [Data and Storage](https://www.notochord.ai/en/dev/storage.md): A gem's own data: declare collections in the manifest, then read and write records, Logs, documents and Blobs with ctx.data; queries and indexes, transactions, version migrations, testing in Gem Studio, encryption and limits.
- [Knowledge API](https://www.notochord.ai/en/dev/knowledge.md): How a gem reads and writes the user's knowledge through ctx.knowledge — concepts, permission strings, the full API, write rules, and uninstall behavior.
- [Tools API](https://www.notochord.ai/en/dev/tools.md): The list of built-in tools and how to define custom tools.
- [Events and Triggers](https://www.notochord.ai/en/dev/events.md): When a gem's workflow (SOP) starts running — how to write the three trigger types (manual, scheduled, platform event), their inputs, limits, and how to troubleshoot.
- [Local development and debugging](https://www.notochord.ai/en/dev/local-dev.md): Draft and test a gem in Gem Studio, then install it on your own machine.
- [Packaging and Publishing](https://www.notochord.ai/en/dev/publishing.md): What an install package contains, the checks at install time and after install, signatures and trust levels, and the ways to distribute that exist today.

## 机器可读配置

- [配置清单](https://config.notochord.ai/v1/index.json): 客户端拉取的全部 JSON 配置的索引