orbit

[!IMPORTANT] Orbit 仍处于早期开发阶段。当前版本没有内置身份认证，请勿直接暴露在公网互联网上；请在本地网络或 Cloudflare Access 等认证代理之后使用。

Orbit 要解决的问题

许多知识管理工具都要求用户先设计文件夹、数据库、属性和自动化规则。Orbit 的做法恰好相反。

1. 把笔记、链接、待办、日程用无格式方式记录到 Inbox。

2. 原始内容始终保留为人类可读的 Markdown + YAML 文件。

3. 在 Today 中同时查看今日待办与日程。

4. 外部智能体（Agent）通过 MCP 访问同一批文件。

5. AI 整理是可选功能，未来的更改建议会先经过您的批准，再在实际中进行确认。

Related MCP server: Knowledge Base MCP Server

当前已完成的功能

• 阅读 Markdown/YAML vault

• 将笔记、链接、日程、链接捕获为 Inbox 文件

• 计算今日待办并完成处理

• Markdown 笔记的列表、搜索、编辑、GFM 预览、标签、归档

• 基于 Neutral 的 shadcn/ui 与深灰暗色

• MCP orbit_capture、orbit_today、orbit_search

• 使用 ORBIT_DATA_DIR 将数据与仓位分离

• 的 But?移动端适配的 Today 界面

尚未实现：登录、AI 自动分类、更改审批画面、vault 全文搜索、CalDAV 同步、Git 自动备份、SSE 文件监控。项目的范围与优先级在路线图中有说明。

快速开始

要求：直接 Node.=22 或更高版本，pnpm 10 或更高版本

git clone https://github.com/kmelon55/orbit.git
cd orbit
pnpm install
cp .env.example .env
pnpm dev

默认 vault 是否在项目内的 ./data。如果想将个人数据与应用代码分开，请使用 .env 中的绝对路径。

ORBIT_DATA_DIR=/data/orbit

文件结构

/data/orbit/
├── inbox/
├── projects/
├── areas/
├── resources/
├── events/
└── archive/

待办事项不会意外出现在独立数据库或 tasks/ 文件夹中。Inbox、Project、Area 内的 Markdown 文件在文件头加入了 type: task，Orbit 会通过这个字段将它们收集到 Today。

---
id: 6c654756-053f-459a-9d73-c8a7c1ff020d
title: 첫 공개 릴리스 준비
type: task
space: project
project: Orbit
status: open
tags:
  - launch
created: 2026-08-23T09:00:00+09:00
updated: 2026-08-23T09:00:00+09:00
---

README와 기본 파일 계약을 검토한다.

完整的文件契约请见 架构文档。

行云 MCP

Orbit MCP 服务器通过 stdio 运行。

ORBIT_DATA_DIR=/absolute/path/to/orbit-data pnpm mcp

MCP 客户端配置示例：

{
  "mcpServers": {
    "orbit": {
      "command": "pnpm",
      "args": ["--dir", "/absolute/path/to/orbit", "mcp"],
      "env": {
        "ORBIT_DATA_DIR": "/absolute/path/to/orbit-data"
      }
    }
  }
}

Hermes 等支持 stdio MCP 的智能体（Agent），都可以通过同样的方式完成连接。具体的 MCP 配置键，请参考您所使用客户端的文档。

Docker / Dokploy

docker build -t orbit .
docker run --rm -p 3000:3000 \
  -e ORBIT_DATA_DIR=/data/orbit \
  -v orbit-data:/data/orbit \
  orbit

在 Dokploy 中，可以直接使用本仓库的 Dockerfile，并把 /data/orbit 挂载为持久卷。对外部公开之前，务必配置认证代理服务。

开发

pnpm test       # Biome + TypeScript
pnpm build      # production build
pnpm mcp        # stdio MCP server

如何贡献请参考 CONTRIBUTING.md。

原则

• 文件是产品中的用户体验常量，不能作为导出的内容。

• SQLite 只用于可重建的数据，比如 read 搜索索引、同步状态、缓存。

• AI 供应商采取 BYOK 模式；即使没有 AI 的支持，基本的待办记录与执行流程也要能正常工作。

• 智能体（Agent）的破坏性更改，应以系统默认流程执行：建议 → 审核 → 应用。

License

MIT