今すぐ始める

ドキュメント

Epismo の基本概念から CLI、HTTP API、MCP server までを一通り理解するためのドキュメントです。

Epismo は、人間と AI agent が同じ作業文脈を扱うためのコラボレーションレイヤーです。再利用したい手順や知識は pack として保存し、いま進めている具体的な作業は track として管理します。CLI、HTTP API、MCP server は同じデータモデルを共有しているため、ローカル操作、CI、自社プロダクト連携、agent クライアントから同じ情報を参照できます。

このドキュメントは、初めて Epismo を使う人が「どの概念を理解すればよいか」「どの interface を使えばよいか」「最初に何を実行すればよいか」で迷わないことを目的にしています。細かい endpoint や command を調べる前に、まずこのページと Core concepts を読むのがおすすめです。

まず理解すること

Epismo には大きく 2 種類の情報があります。

情報 Epismo の object 例 いつ使うか
再利用する知識や手順 Pack 「リリースレビューの手順」「リポジトリ構成メモ」 他の人や agent が後から何度も使う
今進んでいる作業 Track 「API docs をレビューする task」「docs v1 を公開する goal」 状態、期限、担当、依存関係を持つ

迷ったら、次の基準で選びます。

  • 同じ内容を何度も参照したいなら pack にします。
  • 完了状態や期限を持つなら track にします。
  • 手順なら workflow pack、知識のまとまりなら context pack にします。
  • 具体的な作業なら task track、成果目標なら goal track にします。

5 分で試す

CLI を使うと、Epismo の基本モデルを一番早く確認できます。

npm install -g epismo
epismo login --email you@example.com
epismo whoami

まずは、後から再利用する context pack を作ります。

epismo pack create --type context --title "Repo onboarding" --personal \
  --blocks '[{"title":"Layout","content":"apps/, server/, protobuf/ を中心に構成されています。"},{"title":"Local setup","content":"npm install の後、必要な service を起動します。"}]'

作成後に返ってくる pack ID に alias を付けると、以後は UUID ではなく読みやすい名前で参照できます。

epismo alias upsert @repo-onboarding --type context --id <pack-id>
epismo pack get @repo-onboarding --full

次に、実際に進める作業を task track として作ります。

epismo track create --type task --title "Review docs structure" --personal \
  --task '{"status":"todo","dueDate":"2026-06-05"}'
 
epismo track search --type task --personal --filter '{"status":["todo"]}'

ここまでで、Epismo の基本である「再利用する情報は pack」「進行中の作業は track」という流れを確認できます。

どの interface を使うか

Interface 向いている用途 読むページ
CLI ローカル操作、運用、CI、手早い検証 CLI reference
HTTP API 自社サービスや backend からの統合 API reference
MCP server ChatGPT、Claude、社内 agent などから tools/resources として使う MCP server

最初は CLI で作成・検索・更新の流れを掴み、その後に API や MCP に移るのが最も迷いにくい進め方です。CLI の payload は API の request body と近いため、CLI で動いた JSON を API integration の出発点にできます。

Object model

Object 用途 主な fields 補足
Workflow pack 繰り返し使う手順 steps[] step ごとに title/content/assignee/dependency を持てます。
Context pack 再利用する知識ブロック blocks[] repo notes、policy、research summary などに向きます。
Task track 具体的な作業単位 task.status, dueDate, assignee, dependsOn status は backlog, todo, in_progress, done です。
Goal track 進捗を持つ成果目標 goal.status, progress, dueDate progress は 0 から 100 の整数です。
Alias Pack への読みやすい参照 @name, @handle/name Track ではなく pack だけを指します。

共有と権限の考え方

Epismo の private data は personal space、または workspace 内の project に属します。

{ "scope": { "type": "personal" } }
{ "scope": { "type": "projects", "ids": ["project-id"] } }

作成・更新では scope を指定し、検索では複数の場所をまとめて探せるように scopes を指定します。特定ユーザーにも見せたい場合は sharedWith に user ID または email を渡します。

共通ルール

  • 日付は YYYY-MM-DD です。任意の日付は空文字でクリアできます。
  • Markdown content は最大 65,535 文字です。
  • Title は必須で最大 255 文字です。
  • 更新系 API は基本的に PATCH semantics です。省略した field は維持されます。
  • CLI と API は JSON を返します。CLI では stdout が JSON、warning/error は stderr です。

次に読む

  1. Core concepts で pack、track、scope、workspace の判断基準を理解します。
  2. CLI reference で実際に pack と track を作成します。
  3. 自社 service と連携する場合は API reference に進みます。
  4. Agent client から使う場合は MCP server を読みます。

セクション