quickstart.ja.md
docs/i18n/quickstart.ja.md
クイックスタート
<!-- translations:start -->
English · 한국어 · 中文 · 日本語 · Русский · Español · Français · Deutsch
<!-- translations:end --> このページは、既存のプロジェクトディレクトリから閲覧可能な Tesserae までの最短ルートを示します。
コマンド概要
CLI はグループ化されています。トップレベルにいくつかの日常的な動詞があり、残りは グループ(sessions、vault、export、code、config、projects、 integrations、lab)にまとめられています。ツリー全体を見るには tesserae --help を実行します。
usage: tesserae <command> [options]
EVERYDAY
init Set up .tesserae (wizard by default; --yes non-interactive)
compile Rebuild the knowledge graph (compile [paths] = ad-hoc ingest)
context Compile agent-ready context for a query
ask Ask the project memory a question
serve Browse the compiled site (auto-builds if missing)
status Node/edge counts, last compile, vault state
AUTOMATION
engine Refresh daemon: watch sessions/sources, coalesced recompiles
refresh One-shot: import sessions + compile + sync vault
research Autonomous research mode: investigate a query
ANALYSIS
query Raw retrieval over the graph (top-k, kind filters)
lint Graph lint report (--fix-trivial, --severity, --json)
GROUPS
sessions import | discover | list — agent session history
vault sync | sync-all | set-root | export | prune — Obsidian projection
export harness | graphiti | site — artifact exports
code ingest | sync — CodeGraph ⇄ project graph (hook-invoked)
config llm | show — machine-wide defaults (~/.tesserae/config.json)
projects register | list | activate | unregister | mcp-config — registry
integrations refresh raganything|understand-anything
extract Low-level: extract a typed graph from markdown paths
LAB
lab evolve | schema-drift — experimental LLM ops
Run `tesserae <command> --help` for command details.
個々のコマンドの flag を見るには、tesserae <command> --help(例: tesserae compile --help)を実行します。
1. セットアップウィザードの実行
インデックス化したいプロジェクトで:
cd /path/to/my-project
tesserae init
ウィザードは README.md、docs、src、lib、app、packages、data といった一般的な source を検出し、.tesserae/config.json を書き込みます。さらにデフォルトの Cognee backend を構成し、tesserae ask が Cognee を試したうえで、コンパイル済み wiki search に fallback できるようにします。
非対話的なセットアップ(CI、スクリプト)には --yes を渡すと、プロンプトなしで検出されたデフォルトを受け入れます。
tesserae init --yes
Understand Anything と Cognee runtime memory を有効にした完全自動セットアップ:
tesserae init \
--yes \
--with-understand-anything \
--install-understand-anything \
--understand-anything-platform codex \
--with-raganything \
--install-raganything \
--raganything-parser mineru \
--run-raganything \
--run-cognee \
--install-cognee
各オプションの効果:
| Flag | Effect |
|---|---|
--with-understand-anything | UA graph projection を source として追加します。 |
--install-understand-anything | UA companion skills をインストール/更新します。 |
--understand-anything-platform codex | Codex を使って Tesserae 管理の UA refresh wrapper を実行します。 |
--with-raganything | RAG-Anything による multimodal ingestion を有効にします。 |
--install-raganything | セットアップ中に raganything[all] をインストールします。 |
--raganything-parser | パーサーの選択: mineru(デフォルト)、docling、paddleocr。 |
--run-raganything | compile のたびに RAG-Anything を自動 refresh します。 |
--run-cognee | compile 中にベストエフォートで Cognee runtime cognify を実行します。 |
--install-cognee | Cognee がなければ現在の Python でインストールします。 |
ユーザーは UA のインストールパスを知る必要も /understand と入力する必要もありません。UA graph が無いか古い場合、tesserae compile が tesserae integrations refresh understand-anything を実行します。
ウィザードをスキップ。
tesserae init --bareは source 検出や backend 探索を行わず、最小限の.tesserae/config.jsonだけを書き込みます。最初の compile 前に config を手で編集したいときに便利です。
2. グラフと projection のコンパイル
tesserae compile
compile は永続的な artifact を書き込みます。
.tesserae/
config.json
graph.json
manifest.json
sqlite.db
temporal_facts.jsonl
graphiti_episodes.jsonl
report.md
competitive_report.md
markdown_projection/
obsidian_vault/
agent_harness/
harness_sessions/
site/
cognee_bundle/
初回実行後は --changed-only を使って変更されていない markdown ファイルをスキップしつつ、ファイル変更が無いときは前回の graph を保持できます。Understand Anything が有効なら、compile はまず .tesserae/external/understand-anything.md を refresh/materialize します。Cognee runtime が有効なら、.tesserae/cognee_bundle/ を書き込んだ後にベストエフォートで Cognee も更新します。
構成済みの source に触れずに追加パスを ad-hoc で ingest するには、それらを位置引数として渡します: tesserae compile path/to/extra.md docs/。
統合関連のスイッチは config に移動しました
tesserae compile は意図的に日常的な flag(位置引数 paths と --project、 --changed-only、--limit、--refresh-integrations、--sessions/--no-sessions、 そして 3 つの LLM flag)に絞られています。それ以外の従来の compile flag はすべて .tesserae/config.json の compile_options ブロックへ移りました。従来の argparse の デフォルトが引き続き fallback です。挙動を変えるにはそこにキーを設定します。
compile_options キー | 旧 flag | デフォルト | 説明 |
|---|---|---|---|
source_kind | --source-kind | (なし) | 構成済みの source kind を上書きします。 |
trends | --trends | false | corpus レベルの Trend ノードを追加します。 |
min_trend_sources | --min-trend-sources | 2 | Trend ノード生成に必要な最小 source 数。 |
exclude_data | --exclude-data | false | 暗黙の project_root/data 自動取り込みをスキップします。 |
no_vault_pull | --no-vault-pull | false | compile 前に既存の vault 編集を pull しません。 |
use_extraction_feedback | --use-extraction-feedback | false | 以前の extraction 結果を今回の実行に再投入します。 |
sessions_llm | --sessions-llm | (auto) | LLM セッション抽出モード(auto/true/false)。 |
sessions_model | --sessions-model | (なし) | セッション抽出に使う LLM モデルを上書きします。 |
cognee_add | --cognee-add | false | Cognee bundle を dataset に追加します(cognify なし)。 |
cognee_cognify | --cognee-cognify | false | bundle を追加し Cognee cognify を実行します。 |
cognee_codex_cognify | --cognee-codex-cognify | false | Cognee の LLM client を Codex にパッチして cognify を実行します。 |
cognee_codex_model | --cognee-codex-model | gpt-5.4 | cognee_codex_cognify 用の Codex CLI モデル。 |
cognee_codex_timeout | --cognee-codex-timeout | 300 | Codex CLI 呼び出しごとの timeout(秒)。 |
cognee_dataset | --cognee-dataset | tesserae_research_graph | Cognee dataset 名。 |
cognee_embedding_provider | --cognee-embedding-provider | deterministic | Cognee lane の embedding provider。 |
cognee_ollama_embedding_model | --cognee-ollama-embedding-model | qwen3-embedding:0.6b | Ollama embedding モデル。 |
cognee_ollama_embedding_endpoint | --cognee-ollama-embedding-endpoint | http://127.0.0.1:11434/api/embed | Ollama /api/embed endpoint。 |
cognee_ollama_embedding_timeout | --cognee-ollama-embedding-timeout | 120 | Ollama embedding リクエストの timeout(秒)。 |
cognee_local_embedding_dimensions | --cognee-local-embedding-dimensions | 128 | ローカル embedding の次元数。 |
cognee_system_root | --cognee-system-root | (なし) | 隔離された Cognee system root ディレクトリ。 |
cognee_data_root | --cognee-data-root | (なし) | 隔離された Cognee data root ディレクトリ。 |
ワンショットパイプライン。
tesserae refreshは全ループをプロセス内で実行します。新しい agent session の import、compile、vault の sync を 1 つのコマンドで行います。任意のインクリメンタル compile には--changed-onlyを渡します。
3. 静的フロントエンドのビルドと提供
serve は site が無ければ自動的にビルドするため、1 つのコマンドで閲覧可能な Tesserae が得られます。
tesserae serve --port 8765
開く:
http://127.0.0.1:8765/
site を明示的にビルドするには(例: 提供せずにデプロイする場合)export site を使います。既にビルド済みの site をリビルドせずに閲覧したいときは、serve に --no-build を渡します。
tesserae export site
tesserae serve --no-build --port 8765
<!-- BEGIN: subagent-r-watch -->
保存時の自動リビルド
開発サーバーを組み込みの watcher と組み合わせると、data/ と docs/ 配下の編集がインクリメンタル recompile をトリガーします。
# terminal 1
python3 -m http.server 56821 --directory .tesserae/site
# terminal 2
tesserae export site --watch
export site --watch は 2 秒ごとにポーリングし、1 秒の debounce 後に compile --changed-only を実行します。cron スタイルのリビルドには --once(スナップショットを .tesserae/.watch-cache.json と比較)、カスタム監視ディレクトリの追加には --paths <dir>、cadence の調整には --interval / --debounce を使います。 <!-- END: subagent-r-watch -->
refresh デーモンの実行
ソースを監視し、編集のバーストをまとめ、自動で recompile して知識ベースを自ら常に最新に保つ常駐エンジンが欲しい場合は、監督付きデーモンを起動します。
tesserae engine
engine は長時間稼働する supervisor です。2 秒ごとにポーリングし、各リビルドの前に 1 秒の静穏ウィンドウを待ちます。cadence は --interval と --debounce で調整し、別プロジェクトを対象にするには --project、単一の決定的な drain サイクルを実行して終了するには(cron や CI に有用)--once を使います。これは export site --watch の無人版です。実行したままにしておけば、あなたとあなたの agent が作業する間、graph・vault・site が最新に保たれます。
表示されるすべてのルート(home、sources、concepts、entities、papers、repos、topics、syntheses、questions、timeline、graph、そして AI siblings)の注釈付きツアーは