byterover

ByteRover CLI - コンテキストエンジニアリングプラットフォーム

ByteRover は、コーディングエージェント向けにパターン、意思決定、学習内容などのコンテキストを整理できるコンテキストエンジニアリングプラットフォームです。チームメンバー間でコンテキストを自動的に同期し、Markdown ファイルを手動で管理する手間をなくします。

設定

API 認証情報は ~/.clawdbot/byterover-config.json に保存されます。

{
  "apiKey": "your_byterover_api_key_here",
  "team": "your_team_name",
  "space": "your_space_name"
}

Docker を使用した実行

ByteRover CLI の実行には、Node.js 20+ と認証情報の保存に使用する libsecret が必要です。このスキルでは Docker を使用し、必要な依存関係をすべて備えた分離環境を提供します。

ByteRover コンテナーを起動する

cd ~/.openclaw/workspace/skills/byterover
docker-compose up -d

コンテナー内でコマンドを実行する

API キーでログインする：

docker-compose exec byterover brv login --api-key $BRV_API_KEY

プロジェクトを初期化する：

docker-compose exec byterover brv init --headless --team "$BRV_TEAM" --space "$BRV_SPACE"

ステータスを確認する：

docker-compose exec byterover brv status --headless --format json

コンテキストをクエリする：

docker-compose exec byterover brv query "What are the testing strategies?" --headless --format json

コンテキストを整理する：

docker-compose exec byterover brv curate "Make sure to document API authentication patterns" --headless --format json

変更をプッシュする：

docker-compose exec byterover brv push --headless --format json

変更をプルする：

docker-compose exec byterover brv pull --headless --format json

ヘッドレスモード

ByteRover CLI は、自動化やスクリプト実行向けのヘッドレスモードをサポートしています。ヘッドレスモードでは対話型プロンプトが無効になり、機械処理可能な JSON 出力に対応します。

--headless でサポートされるコマンド

• brv init（--team と --space が必要です）
• brv status
• brv query
• brv curate
• brv push（確認を自動的にスキップします）
• brv pull

出力形式

--format を使って出力形式を指定します。

• text（デフォルト）：人が読みやすいテキスト出力
• json：機械処理用の NDJSON（改行区切り JSON）

API キー認証

ヘッドレス環境では、OAuth のブラウザーフローの代わりに API キーを使用します。

brv login --api-key $BRV_API_KEY

コンテキストツリー

コンテキストツリーは、プロジェクトのコンテキストをドメイン別に整理する、ByteRover の構造化されたナレッジシステムです。

• 構造 - プロジェクトのアーキテクチャとパターン
• データベース - スキーマ、マイグレーション、リレーションシップ
• バックエンド - API エンドポイント、ビジネスロジック
• フロントエンド - UI コンポーネント、状態管理
• テスト - テスト戦略、フィクスチャ
• デプロイ - インフラストラクチャ、CI/CD
• ドキュメント - ガイド、API ドキュメント

使用例

AI コーディングエージェント向け

コーディングエージェントにプロンプトを入力します：

brv query コマンドを使って、このプロジェクトで使用されている認証パターンを確認してください

エージェントが実行するコマンド：

brv query "What authentication patterns are used?" --headless --format json

手動での使用

プロジェクトのステータスを確認する：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv status

ターミナルからコンテキストを追加する：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv curate "Document the API rate limiting strategy"

特定の知識をクエリする：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv query "How do we handle rate limiting?"

ヘルパースクリプト

ステータスをすばやく確認する

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/status.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv status --headless --format json

コンテキストをクエリする

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/query.sh

QUERY="${1:-project overview}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv query "$QUERY" --headless --format json

コンテキストを追加する

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/curate.sh

CONTEXT="${1}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv curate "$CONTEXT" --headless --format json

変更を同期する

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/sync.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover

echo "Pulling latest context..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv pull --headless --format json

echo "Pushing local changes..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv push --headless --format json

Docker の管理

イメージをビルドする：

cd ~/.openclaw/workspace/skills/byterover
docker-compose build

コンテナーを起動する：

docker-compose up -d

コンテナーを停止する：

docker-compose down

ログを表示する：

docker-compose logs -f

コンテナーのシェルに入る：

docker-compose exec byterover bash

AI エージェントとの統合

ByteRover は、複数の統合方法を提供します。

1. スキルファイル（Claude Code、Cursor）

エージェントが確認し、自動的に実行できる、最新の見つけやすいスキルファイルです。

2. MCP ツール（汎用）

幅広いエージェントとの互換性を実現する Model Context Protocol ツールです。

3. ルールベース（レガシー）

古い統合向けに生成されるルールファイルです。

JSON 出力の構造

メッセージの種類を含む NDJSON 形式です。

• log：進行状況メッセージ
• output：メインの出力内容
• error：エラーメッセージ
• warning：警告メッセージ
• result：操作の最終結果

環境変数

• BRV_API_KEY - ByteRover API キー
• BRV_TEAM - チーム名
• BRV_SPACE - Space 名
• BRV_HEADLESS - ヘッドレスモードを有効にします（true）
• BRV_FORMAT - 出力形式（json/text）

注意事項

• ByteRover の初回セットアップには、ブラウザーベースの OAuth フローが必要です
• API キー認証を使うと、ヘッドレス環境で OAuth を省略できます
• コンテキストはチームメンバー間で自動的に同期されます
• コードベースに Markdown ファイルが散らかることはありません
• 19 種類以上の AI コーディングエージェントで動作します

トラブルシューティング

ビルドに失敗する場合：

• Docker デーモンが実行中であることを確認してください
• ポート 80/443 が使用可能か確認してください

ログインに失敗する場合：

• API キーが有効であることを確認してください
• チーム名とスペース名が正しいことを確認してください

コンテナが終了する場合：

• ログを確認してください：docker-compose logs
• /workspace が正しくマウントされていることを確認してください

クエリで結果が返されない場合：

• brv init でプロジェクトを初期化してください
• brv curate でコンテキストを追加してください
• brv pull で同期してください

要件

• Docker
• Docker Compose
• ByteRover アカウント
• 有効なチームとスペース

ライセンス

MIT

作者

Jun Suzuki が OpenClaw 向けに作成

---

ByteRover の詳細については、次の URL をご覧ください：https://docs.byterover.dev/