llms.txt
# Busabase
Busabase is the system of record for AI agents — an open-source (MIT) database and workspace where agents and people share the same data, docs, skills, and apps. Run it on your own machine, self-host it inside your network, or use Busabase Cloud. Every change keeps its history, and the writes that matter can wait for a person to review.
## What Busabase is
Busabase is a system of record for AI agents: the place where the business facts an agent
produces are stored, attributed, and treated as authoritative. An agent connected to a Busabase
workspace does not write to a table invisibly — it opens a Change Request, so every fact arrives
with a message, a diff and an author. Whether that request applies straight away or waits for a
human is set by the credential's permission level, so you can hold back exactly the data that
warrants it. Merged records keep their provenance (which agent, which request, which reviewer)
and their full history, including rejected versions.
This is distinct from an "Agent System of Record" in the Workday sense, which governs the agents
themselves — their identity, permissions, and performance. Busabase governs what the agents wrote.
Review is proportional, not universal: a credential with write access applies its changes
straight away, and only credentials you have not trusted with write access wait for a person.
Busabase is a workspace agents build on, not an approval queue.
Agents connect over MCP, an agent skill, or the OpenAPI surface.
## Where your data lives
- Open source under the MIT license: https://github.com/busabase/busabase
- Busabase Desktop and the open-source server (npm `busabase`, Docker image `busabase/busabase`)
store data on your own machine by default (`~/.busabase/data`; `/data` in Docker). There is no
usage telemetry, and it works offline.
- Self-host it with Docker inside your own network. Nothing about the open-source edition requires
Busabase Cloud or a Busabase account.
- Busabase Cloud is the hosted option, for teams that want to collaborate without running a server.
- Outbound connections worth knowing about in the open-source edition: a package update check
(npm registry; set `BUSABASE_NO_UPDATE_CHECK=1` to turn it off), the desktop app's update check,
the template catalog (GitHub, only when you open it), and the AirApp runtime and API docs page,
which load scripts from public CDNs. None of these send your workspace data. What does send data is only what you set up yourself: an LLM provider for your agents, or
Cloud Connect to reach a local workspace from Busabase Cloud.
- Security notes for self-hosting: https://busabase.com/docs/self-hosted/security
## Documentation
- [Full Documentation](https://busabase.com/llms-full.txt)
- [Docs](https://busabase.com/docs)
## Quick Links
- [Get Started](https://busabase.com/docs)
- [System of Record for AI Agents](https://busabase.com/system-of-record-for-ai-agents)
- [Connect your agent](https://busabase.com/connect-agents)
- [API Documentation](https://busabase.com/api/v1/doc)
- [GitHub (open source, MIT)](https://github.com/busabase/busabase)
- [Partners program](https://busabase.com/partners) — affiliates earn 30% of first-year revenue (180-day window); solutions and technology partners
## How an agent connects
If you are an agent reading this, these are the four entry points that actually connect you to a
workspace. Everything above describes Busabase; these let you use it.
- [Setup document](https://busabase.com/SETUP_SKILL.md) — the one-time onboarding document. An agent can read
it start to finish and end up connected, with a first Base seeded when needed. It reuses an
existing Busabase MCP integration when available or signs in through the CLI, then installs the
permanent Busabase skills for future sessions regardless of the connection transport.
- [MCP endpoint](https://busabase.com/api/mcp) — the Model Context Protocol server, for clients that register
Busabase as a set of tools rather than calling it over HTTP.
- [OpenAPI contract](https://busabase.com/api/v1/openapi.json) — the complete machine-readable description of
every endpoint, for generating a client or checking one endpoint's exact arguments. It is browsable
at [https://busabase.com/api/v1/doc](https://busabase.com/api/v1/doc).
- `npx --yes busabase-cli@latest` — the command line client, for agents that work in a shell. It
needs no install step, and `busabase-cli skill` prints that same skill document offline, so an
agent that has the CLI already has the instructions.
### Connecting without remote instructions
Teams that do not let agents follow instructions fetched from a URL can skip the setup document
entirely. Install a pinned CLI version from npm, then run `busabase-cli skill install`: it writes
the skill file into your agent's skills directory, generated locally from the CLI itself and bound
to your own Busabase host. Review the file like any other code, and nothing is re-fetched at
session time. Busabase Desktop and self-hosted servers serve their own setup document from your
host, never from busabase.com.
## Documentation Pages
- [Welcome to Busabase](/docs): Busabase is a headless review database for AI-generated content — the place where you approve, revise, and merge what's good enough to trust.
- **Getting Started**
- [Quick Start](/docs/quickstart): From sign-up to approving your first AI-submitted record in about 5 minutes.
- [Integration Overview](/docs/integrations): Choose how to connect to Busabase through the browser, CLI, SDK, MCP, OpenAPI, agent skills, events, automation, or imports.
- [Mobile App](/docs/mobile-app): Review, approve, and browse Busabase work from a native-feeling phone companion.
- [Core Concepts](/docs/core-concepts): The git-shaped mental model behind Busabase: bases, fields, records, commits, change requests, and variants.
- [Node Types](/docs/node-types): Folder, Base, Whiteboard, Workflow, HTML, Skill, Drive, AirApp, File, and Doc nodes in Busabase.
- **Templates**
- [Templates](/docs/templates): Install a complete app — tables, an interface, and the manual an agent reads before it touches your data — from the Template Center, the CLI, or your agent's own shell.
- [Template format](/docs/template-format): What a Busabase template directory contains — the root SKILL.md, the template object in busabase.json, .busabaseignore, the validator's rules, and the ownership stamp that lets two installers recognise the same app.
- [Publish a template](/docs/publish-template): Turn a folder you already built into an installable app — busabase-cli export --template, the SKILL.md draft, the catalog index, and how to point a self-hosted server at your own gallery.
- **Working with Data**
- [Workspaces](/docs/workspaces): Organize your bases and team inside a workspace.
- [Bases](/docs/bases): How Bases organize your content: fields, records, and views.
- [Field Types](/docs/field-types): The flexible field registry: text, number, select, attachment, relation, and more.
- [Records](/docs/records): The canonical, approved rows on your main branch.
- [Attachments & Assets](/docs/attachments): Store files and multimodal content alongside your records.
- **Review Workflow**
- [The Inbox](/docs/inbox): Triage everything your agents submit from one queue.
- [Change Requests](/docs/change-requests): Pull requests for your data: open, review, approve, reject, merge.
- [Commits & Audit Trail](/docs/commits-audit): An immutable history you can diff, replay, and trust.
- [Variants](/docs/variants): Single-parent content variants for channels, locales, and formats.
- **Agent -> Busabase**
- [Get Started with Agents](/docs/agents-getting-started): Choose Busabase Cloud or Desktop, connect your agent with the right guide, and add MCP only when you need it.
- [Bring Your Own Agent](/docs/bring-your-agent): Connect any coding agent — Claude Code, Cursor, Codex — to drive Busabase. One prompt to onboard, one command to install a permanent skill.
- [Codex Plugin](/docs/codex-plugin): Install the Busabase Codex plugin from the busabase/skills marketplace and verify its Cloud MCP connection.
- [Claude Code Plugin](/docs/claude-code-plugin): Install the Busabase Claude Code plugin, authorize its Cloud MCP connection, and use its change-request skills.
- [DeepSeek Harness Plugin](/docs/deepseek-harness-plugin): Install the Busabase plugin in DeepSeek Harness Desktop, then choose managed Local, an existing server, or Cloud.
- [MCP + OAuth](/docs/mcp): Connect Codex, Claude Code, Cursor, Gemini CLI, OpenClaw, WorkBuddy, Buda Agent, or Hermes to Busabase safely.
- [Skills](/docs/skills): The official Busabase skills — busabase, busabase-app-creator, busabase-template-creator — how to install and use them, and how skills hosted in your workspace let every agent behave the same way.
- [Agent Playbooks](/docs/agent-playbooks): How agents find the skills and custom prompts you saved in your workspace, and how to write them so they get found.
- **Busabase -> Agent**
- [@AI Comments](/docs/ai-comments): Revise content in natural language, right from the review thread.
- [Chat with Claude Code or Codex](/docs/agent-chat): Connect a local coding agent to Busabase, choose its model, and run the first chat safely.
- **Developers**
- [What to build](/docs/what-to-build): Package, Agent Skill, template, or AirApp — the four things you can build for Busabase, how they nest, which one your idea actually is, and what each one costs you to ship.
- [Build an AirApp](/docs/build-an-airapp): Write an interface that opens inside a Busabase workspace — the project layout, Hono plus vanilla browser code, reading the injected runtime instead of the hostname, page budgets, and shipping it through review.
- [Build a Platform Integration](/docs/platform-integration): Add Busabase to your product's third-party integrations catalog — OAuth 2.1 discovery, dynamic client registration, multi-tenant space targeting, and the change-request tool contract, using Buda's own integration as the reference implementation.
- [API keys](/docs/api-keys): Issue scoped, revocable API keys for agents and downstream systems.
- [CLI Installation & Connection](/docs/cli): Install busabase-cli, sign in, choose a workspace, and verify your first read.
- [SDK Installation & Quick Start](/docs/sdk): Install the TypeScript / JavaScript SDK and read your first workspace data.
- [CLI Accounts & Workspaces](/docs/cli-accounts): Keep several Busabase accounts on one machine, and switch workspaces without signing in again.
- [Vault & Secrets](/docs/vault-secrets): Store secrets and variables for Busabase-hosted runtime, scoped overrides, and audited access.
- [REST API](/docs/rest-api): Submit and read records over a simple HTTP API.
- [Embed Links](/docs/embed-links): Create short-lived, brandless links for agent previews and third-party embeds.
- [Search Everything](/docs/search-grep): Supply searchable file text, grep files, Docs, records, and custom prompts, then read only the matching range.
- [Webhooks & Events](/docs/webhooks-events): React to approvals, mentions, and uploads in real time — no code required, or a little code if you need it.
- [Tunnel](/docs/tunnel): Connect a local agent to your cloud workspace.
- [Backup & Restore](/docs/busabase-dump): Back up a Busabase space to a single portable archive, and restore it — full history, original ids, real files — with busabase-cli backup and restore.
- [Install & Export (packages)](/docs/install-export): Turn part of a Busabase space into a git repo anyone can install from a GitHub URL — and install someone else's from the dashboard or with busabase-cli, merged on the spot or sent for review first.
- OpenAPI Reference
- [OpenAPI Reference](/docs/api-openapi): Browse the complete Busabase REST API, generated directly from the live oRPC contracts.
- [Activity](/docs/api-openapi/activity): Workspace activity and event history.
- [Agent Tasks](/docs/api-openapi/agent-tasks): AI agent task management
- [Agent](/docs/api-openapi/agent): Agent definitions and execution endpoints.
- [Assets](/docs/api-openapi/assets): Workspace asset management.
- [Audit](/docs/api-openapi/audit): Audit records for workspace operations.
- [Auth](/docs/api-openapi/auth): Auth verification — resolves the targeted space, user, membership, and every space you belong to from your API key.
- [Authentication](/docs/api-openapi/authentication): Authentication and API key management.
- [Bases](/docs/api-openapi/bases): Workbench Bases — developer-facing table/database API.
- [Change Requests](/docs/api-openapi/change-requests): Human review workflow for proposed changes.
- [Comments](/docs/api-openapi/comments): Comments attached to workspace content.
- [Community](/docs/api-openapi/community): Community forum categories, posts, and replies.
- [Docs](/docs/api-openapi/docs): Document content and editing endpoints.
- [Dump](/docs/api-openapi/dump): Workspace export and diagnostic data.
- [Embed Links](/docs/api-openapi/embed-links): Short-lived, revocable, read-only links for rendering one Node as standalone content or in a third-party iframe.
- [Favorites](/docs/api-openapi/favorites): User favorite nodes and resources.
- [File Trees](/docs/api-openapi/file-trees): Skills, Drives, and AirApps — node types whose content is an Asset-backed file tree, served by one surface discriminated by `type`.
- [Files](/docs/api-openapi/files): File metadata and content endpoints.
- [Folders](/docs/api-openapi/folders): Folder content and organization.
- [Forms](/docs/api-openapi/forms): Form nodes that submit into a Base for review — a form submission always waits for a human, whoever submitted it.
- [Guides](/docs/api-openapi/guides): The operating manual, in the same words the MCP server publishes. Read `workspace` before proposing changes and `airapp` before writing any AirApp file — the conventions a workspace expects are not expressible in a schema.
- [Install](/docs/api-openapi/install): Package and workspace installation endpoints.
- [Nodes](/docs/api-openapi/nodes): Workspace tree: folders, Bases, files, agents.
- [Onboarding](/docs/api-openapi/onboarding): Workspace onboarding and bootstrap state.
- [Operations](/docs/api-openapi/operations): Long-running workspace operation status.
- [Permissions](/docs/api-openapi/permissions): Node and workspace permission management.
- [Playbooks](/docs/api-openapi/playbooks): The skills and custom node prompts this space already defines for a job. Call `POST /api/v1/playbooks/search` first on every instruction with a few phrasings of the intent; open a hit with `GET /api/v1/playbooks/{kind}/{nodeId}` and follow it.
- [Records](/docs/api-openapi/records): Canonical records after approved change requests merge.
- [Search](/docs/api-openapi/search): Search across workspace content.
- [Sharing](/docs/api-openapi/sharing): Public link sharing for individual nodes.
- [System](/docs/api-openapi/system): System health and metadata endpoints
- [Templates](/docs/api-openapi/templates): The Template Center catalog: installable apps published by a template repository. Read-only — installing one goes through Install.
- [Users](/docs/api-openapi/users): User management endpoints
- [Vault](/docs/api-openapi/vault): The runtime slice of the Vault for the calling credential — personal, Space, and API-key scopes merged most-specific-wins, filtered to items the owner marked `runtime`. Same values a task already receives in its environment; items not marked `runtime` never appear.
- [Views](/docs/api-openapi/views): Base view configuration and metadata.
- [Webhooks](/docs/api-openapi/webhooks): Webhook registration and delivery management.
- [Troubleshooting](/docs/troubleshooting): What the common Busabase errors mean and how to fix them — for both Cloud and local Desktop, over the CLI, curl, or any agent.
- **Use Cases**
- [Use Cases](/docs/use-cases): Real-world setups, from a content factory to dataset labeling.
- [Content Factory](/docs/usecase-content-factory): Run a multi-agent content pipeline with humans in the loop.
- [Dataset Labeling](/docs/usecase-dataset-labeling): Review and approve AI-labeled training data with a full audit trail.
- [Compliance Review](/docs/usecase-compliance-review): Enforce N-of-M approvals and veto policies on sensitive content.
- **Account**
- [Teams, Members & Groups](/docs/organizations): Invite members to a workspace, manage member roles, and organize your team with groups.
- [Billing & Plans](/docs/billing): View workspace subscriptions and usage, complete payments, find invoices, and handle cancellations, refunds, or payment issues.
- [Referral Program](/docs/referrals): Get and share your referral link to help friends sign up for Busabase Cloud.
- **Self-Hosted**
- [Self-hosting Busabase](/docs/self-hosted/overview): Which edition you need, what each deployment shape costs you in operational effort, and the measured hardware requirements — so you can decide before you download anything.
- [Quickstart](/docs/self-hosted/quickstart): Install Busabase on your own server with one command, check it actually worked, and activate your licence — including on a network with no internet access.
- [Production with Compose](/docs/self-hosted/production-compose): The four-service Compose deployment — Postgres, object storage, a one-shot migration job and the app — plus TLS, external databases, and the credential trap that breaks attachment uploads.
- [Kubernetes (Helm)](/docs/self-hosted/kubernetes-helm): Install Busabase Premium with Helm — what the chart does, the two values that break attachments and sign-in when they are wrong, and when to bring your own Postgres and S3.
- [Installing without internet access](/docs/self-hosted/offline-install): Move the image as a file, verify it arrived intact, and activate the licence on a machine that has never been online.
- [Configuration reference](/docs/self-hosted/configuration): Every environment variable the self-hosted deployment reads — what it does, what happens if you get it wrong, and whether changing it needs a restart.
- [Licensing](/docs/self-hosted/license): How activation codes work, what happens when one expires, what each error message means, and how seats are counted.
- [Backup and restore](/docs/self-hosted/backup-restore): The three things you have to back up, a script that does all three, and a restore drill you should run before you need it.
- [Upgrading](/docs/self-hosted/upgrade): How to move to a newer version, what happens when a migration fails, and why rolling back means restoring a backup rather than downgrading.
- [Troubleshooting](/docs/self-hosted/troubleshooting): The failures we expect you to hit, what each one actually means, and how to collect a support bundle that does not contain your credentials.
- [Security](/docs/self-hosted/security): What leaves your network (nothing), which ports are open, where secrets live, and the hardening steps worth doing.
- **Links**
- [Home](/)
- [Try Demo](/dashboard?demo=1)
- [Github](https://github.com/busabase/busabase)
# 文档
- [欢迎使用 Busabase](/zh-CN/docs): Busabase 是面向 AI 生成内容的 headless 审核数据库——在这里批准、修改并合并值得信赖的内容。
- **快速开始**
- [快速开始](/zh-CN/docs/quickstart): 从注册到批准你的第一条 AI 提交记录，约 5 分钟。
- [接入方式总览](/zh-CN/docs/integrations): 按照工作需要选择浏览器、CLI、SDK、MCP、OpenAPI、Agent Skill、Webhook、自动化或导入。
- [手机版 App](/zh-CN/docs/mobile-app): 在手机上用更接近原生的方式审核、批准和浏览 Busabase 工作流。
- [核心概念](/zh-CN/docs/core-concepts): Busabase 背后类 git 的心智模型：Base、字段、记录、提交、变更请求与变体。
- [节点类型](/zh-CN/docs/node-types): Busabase 中的 Folder、Base、Whiteboard、Workflow、HTML、Skill、Drive、AirApp、File 与 Doc 节点。
- **模板**
- [模板](/zh-CN/docs/templates): 从模板中心、命令行，或者你自己 agent 的终端里，装进一个完整的应用——表、界面，以及 agent 动你数据之前要读的那份手册。
- [模板格式](/zh-CN/docs/template-format): 一个 Busabase 模板目录里有什么——根部的 SKILL.md、busabase.json 里的 template 对象、.busabaseignore、校验器的规则，
