コンテンツにスキップ
Documentation

AIエージェントのカスタマイズ

このページ上のすべての内容はローカルファイルです。以下のディレクトリにあるファイルは .champrep/ リポジトリ内の 場所は、gitを通じてチームと共有されます。以下のディレクトリにあるファイルは $CONFIG/ai/ は、すべてのプロジェクトにおいて、ご自身のみに適用されます。プロジェクトとユーザー定義の 名前が同じ場合、プロジェクト側の定義が優先されます。

プロジェクトのコンテンツは .champrep/ は、リポジトリを信頼するまで非アクティブのままです。 詳細はこちら リポジトリの信頼.

CHAMPREP.md には、エージェント向けの常設の指示が格納されています。プロジェクトの構築やテストの方法、 規約、避けるべき事項などが含まれます。エージェントは、各セッションの開始時に これらを読み込みます:

  • $CONFIG/ai/CHAMPREP.md、すべてのプロジェクトに対する個人用の指示です。
  • CHAMPREP.md プロジェクトのルートディレクトリ、およびルートからエージェントを起動した場所までの各ディレクトリ内にあります。 。

ディレクトリに CHAMPREP.md、 AGENTS.md の代わりに が使用されます。

アクション方法
作成する/init はリポジトリを調査し、 CHAMPREP.md、既存のコンテンツから有用な部分を引き継ぎます。 AGENTS.md.
メモを追加するプロンプトを次のように開始します。 #、例えば # run make lint before committing.
表示または編集/memory、または /memory edit [user|project|FILE] と入力して、エディタで開くことができます。

ウェブ上の設定CHAMPREP AIで管理されているアカウントCHAMPREP AIのメモリは、 ターミナルでも適用されます。 カスタムコマンド カスタムコマンドとは、“として実行するMarkdownプロンプトテンプレートです。 場所 /memory は読み取り専用として表示されます。

カスタムコマンドとは、として実行するMarkdownプロンプトテンプレートです。 /<name>.

場所スコープ
.champrep/commands/NAME.mdこのプロジェクト
$CONFIG/ai/commands/NAME.mdあなた

サブフォルダ内のファイル、例えば commands/git/commit.md, は /git:commit。次のようにして作成します。 /commands new NAME そして、以下で一覧を表示します。 /commands.

---
description: Explain a failing test and propose a fix
argument-hint: <test name>
allowed-tools: [local_read_file, local_grep, local_bash]
---
Find the test named $1, run it, and explain why it fails.
Relevant notes: @docs/testing.md
Recent changes:
!`git log --oneline -5`
  • $ARGUMENTS は、コマンド名の後のすべてを指します; $1, $2、… は 単一の引数です。テンプレートがこれらを使用しない場合、引数は末尾に追加されます。
  • @path ワークスペースファイルを含みます。シークレットファイルは決して含まれません。
  • !`command` テンプレートを呼び出す際にコマンドを実行します。 テンプレートごとに1回、また変更があるたびに、承認を求められます。
  • allowed-tools そのターンで使用できるツールを制限し、 model は モデルを上書きします。

スキルとは、指示やオプションの補助ファイルが格納されたフォルダであり、 エージェントは必要な場合にのみこれを読み込みます。それまでは、モデルにはスキルの 名前と説明のみが表示されるため、多くのスキルはコンテキストの消費がごくわずかです。

場所スコープ
.champrep/skills/NAME/SKILL.mdこのプロジェクト
$CONFIG/ai/skills/NAME/SKILL.mdあなた
---
description: Release checklist for this service
when_to_use: When the user asks to cut, tag, or publish a release
---
1. Confirm the changelog has an entry for the new version.
2. ...

/skills スキルの一覧を表示します。これには、ご自身のアカウントCHAMPREP AIのスキルも含まれます。 で直接実行するには /<skill-name>.

カスタムエージェントとは、独自の指示、ツール、およびモデルを持つサブエージェントのことです。

場所スコープ
.champrep/agents/NAME.mdこのプロジェクト
$CONFIG/ai/agents/NAME.mdあなた
---
name: test-writer
description: Writes and fixes unit tests. Use after a code change.
tools: [local_read_file, local_grep, local_glob, local_edit_file, local_bash]
permission_mode: accept-edits
isolation: worktree
---
You write focused unit tests that follow this project's existing style.
  • description は、メインエージェントに対して、いつ処理を委譲すべきかを伝えます。
  • tools でツールを絞り込みます。省略すると、セッションのツールを継承します。
  • permission_mode は、セッションよりもエージェントの権限を厳格にすることしかできません。
  • isolation: worktree 独自の Git ワークツリー内で実行します。

エージェントの管理には /agents create|edit|delete NAME。 エージェントとしてセッションを開始するには champrep ai --agent NAME、または @NAME prompt。詳しくは サブエージェント.

フックとは、セッション中の特定のタイミングで が実行CLIするシェルコマンドのことです。例えば、 編集後のファイルの書式設定や、特定のコマンドをブロックする場合などに使用されます。

イベント実行されます
SessionStartセッションが開始されたとき。
UserPromptSubmitプロンプトが送信される前。プロンプトをブロックしたり、コンテキストを追加したりできます。
PreToolUseローカルツールが実行される前。実行をブロックできます。
PostToolUseローカルツールが実行された後。結果にフィードバックを追加できます。
PermissionRequest権限プロンプトが表示されたとき。
Notificationエージェントからの通知時。
SubagentStopサブエージェントが終了したとき。
PreCompact会話が圧縮される前。
Stopターンが終了したとき。
SessionEndセッションが終了したとき。

任意の設定ファイルでフックを設定します:

{
"hooks": {
"PostToolUse": [
{ "matcher": "local_edit_file|local_write_file", "command": "npm run format --silent", "timeout": 30 }
],
"PreToolUse": [
{ "matcher": "local_bash", "command": "./scripts/check-command.sh" }
]
}
}
  • matcher はツール名の正規表現です。省略すると、 すべてのツールに一致します。
  • フックは、標準入力からイベントに関するJSON記述を受け取ります。
  • 終了コード 2、または JSON 出力( "decision": "block" および reason, イベントが許可している場合、そのアクションをブロックします。 additionalContext JSON形式 出力には、モデル用のテキストが追加されます。
  • デフォルトのタイムアウトは60秒で、最大は10分です。
  • フックは、認証CHAMPREP情報を除いた環境設定で実行されます。

フックの管理には /hooks, /hooks add EVENT [--matcher M] [--timeout S] [--scope user|project] -- COMMAND, /hooks disable ID、および /hooks enable ID.

コマンドオプション
/color並行するセッションを区別するために、このプロジェクトのセッションにアクセントカラーを設定します: blue, cyan, green, yellow, orange, red, pink, magenta, purple, gray、または reset.
/themeauto, dark, light, high-contrast、または colorblind. NO_COLOR および --no-color 色をオフにします。
/statuslineからセグメントを選択します profile, model, context, branch, mode, cost、および tasks; を使用します /statusline command CMD 自身のコマンドの出力の最初の行を表示します; /statusline reset デフォルトに戻します。
/output-styledefault, concise, explanatory、または learning.
/vimプロンプトでのVimスタイルの編集。
/keybindingsキーバインドを表示します; /keybindings edit を開きます $CONFIG/ai/keybindings.json.
/config上記のすべてを1つの画面に表示します。

エージェントの会話は、あなたの アカウントCHAMPREP AI上に保存されます。 マシン固有の状態のみがローカルに保存されます。マシン上のすべての場所を表示するには、 以下を入力してください:

Terminal window
champrep ai paths
内容場所
CLI プロファイルと環境$CONFIG/config.toml
エージェントの設定:ルール、モード、テーマ、ステータス行、フック$CONFIG/ai/settings.json
キーバインディングのオーバーライド$CONFIG/ai/keybindings.json
ご自身の指示$CONFIG/ai/CHAMPREP.md
エージェント、コマンド、およびスキル$CONFIG/ai/agents/, commands/, skills/
ローカルの MCP サーバー$CONFIG/ai/mcp.json
信頼済みプロジェクト$CONFIG/ai/trusted-projects.json
ディレクトリごとの最近の会話、およびタスクリスト$STATE/ai/sessions.json
プロンプト履歴(一部非表示・文字数制限あり)$STATE/ai/history.jsonl
デバッグログ(一部非公開、7日間保存)$STATE/ai/logs/
ファイルのチェックポイント$CACHE/ai/checkpoints/
プロジェクト設定(コミット可能).champrep/settings.json, mcp.json, agents/, commands/, skills/
プロジェクトによる上書き(git-ignored).champrep/settings.local.json
プロジェクトの指示CHAMPREP.md
ワークツリー.champrep/worktrees/

認証情報は、これらのファイルには一切保存されません。認証情報は、オペレーティングシステムの キーチェーンに保持されます。

RootmacOS および LinuxWindows
$CONFIG$XDG_CONFIG_HOME/champrep、それ以外の場合 ~/.config/champrep%APPDATA%\champrep
$STATE$XDG_STATE_HOME/champrep、それ以外の場合 ~/.local/state/champrep%LOCALAPPDATA%\champrep\state
$CACHE$XDG_CACHE_HOME/champrep、それ以外の場合 ~/.cache/champrep%LOCALAPPDATA%\champrep\cache

設定 CHAMPREP_CONFIG_DIR これら3つすべてを1つのディレクトリにまとめるには、 config/, state/、および cache/ サブフォルダ。これは、ポータブルなインストールや 隔離された CI 実行に役立ちます。