orbit

[!IMPORTANT] Orbitはまだ初期開発段階です。現在のバージョンには独自の認証がないため、公開インターネットに直接公開せず、ローカルネットワークやCloudflare Accessなどの認証プロキシの背後で使用してください。

Orbitが解決しようとする問題

既存の知識管理ツールは、ユーザーにフォルダ、データベース、プロパティ、自動化ルールを先に設計するよう求めることがよくあります。Orbitはその逆に動作します。

1. メモ、リンク、ToDo、スケジュールを形式なしでInboxに記録します。

2. 原本は人間が読めるMarkdown + YAMLファイルとして残ります。

3. Todayで今日の実行項目とスケジュールを一緒に確認します。

4. 外部エージェントはMCPを通じて同じファイルにアクセスします。

5. AI整理は選択機能であり、将来の変更提案をユーザーが承認した後に適用します。

Related MCP server: Knowledge Base MCP Server

現在できること

• Markdown/YAML vaultの読み取り

• メモ、ToDo、スケジュール、リンクをInboxファイルとしてキャプチャ

• 今日のToDoの計算と完了処理

• Markdownノートの一覧、検索、編集、GFMプレビュー、タグ、アーカイブ

• 最近のInboxと予定スケジュールの表示

• Neutralベースのshadcn/uiとダークグレーのダークモード

• MCP orbit_capture, orbit_today, orbit_search

• ORBIT_DATA_DIRによるデータ場所の分離

• モバイル対応のToday画面

まだないもの: ログイン、AI自動分類、変更承認画面、vault全体検索、CalDAV同期、Git自動バックアップ、SSEファイル監視。範囲と順序はロードマップにまとめられています。

クイックスタート

要件: Node.js 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/

ToDoは別のデータベースや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サーバーをサポートするエージェントで同じ方法で接続できます。具体的な設定キーは使用するクライアントのドキュメントを確認してください。

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を参照してください。

原則

• ファイルは製品のエクスポート形式ではなく、Source of Truthです。

• SQLiteは検索インデックス、同期状態、キャッシュのような再生成可能なデータにのみ使用します。

• AIプロバイダーはBYOKであり、AIなしでも基本的な記録と実行フローが動作する必要があります。

• エージェントの破壊的な変更は、デフォルトで提案 → レビュー → 適用の段階を経ます。

ライセンス

MIT