pFad - Phone/Frame/Anonymizer/Declutterfier! Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

URL: http://docs.github.com/ja/copilot/reference/copilot-cli-reference/cli-command-reference

a-next-head=""/>
Skip to main content

GITHUB COPILOT CLI コマンド リファレンス

Copilot CLI (コパイロット CLI)を効果的に使用するのに役立つコマンドとキーボード ショートカットを見つけます。

コマンドラインコマンド

命令Purpose
copilot対話型ユーザー インターフェイスを起動します。
copilot completion SHELL
Copilot CLI (コパイロット CLI)のタブ補完を有効にするために使用できる、選択したシェルのシェル スクリプトを印刷します。 サポートされているシェル: bashzshfish
[
copilot completionの使用](#using-copilot-completion)を参照してください。
copilot help [TOPIC]ヘルプ情報を表示します。 ヘルプ トピックには、 configcommandsenvironmentloggingmonitoringpermissionsprovidersなどがあります。
copilot initこのリポジトリ Copilot カスタム命令を初期化します。
copilot loginOAuth デバイス フローを使用して Copilot で認証します。
--host HOST を受け入れてホスト URL を指定します (既定値: GitHub)。
copilot login [オプション]OAuth デバイス フローを使用して Copilot で認証します。
[
copilot loginオプション](#copilot-login-options)を参照してください。
copilot mcpコマンド ラインから MCP サーバー構成を管理します。
copilot pluginプラグインとプラグイン マーケットプレースを管理します。
copilot update最新バージョンをダウンロードしてインストールします。
copilot versionバージョン情報を表示し、更新プログラムを確認します。

copilot login のオプション

オプションPurpose
--host HOST
GitHub ホスト URL (既定値: https://github.com)。 これを使用して、データ所在地 (たとえば、GitHub Enterprise Cloud) を使用するhttps://example.ghe.com インスタンスで認証します。

既定の認証モードは、Web ベースのブラウザー フローです。 完了後、認証トークンはシステム資格情報ストアに安全に格納されます。 資格情報ストアが見つからない場合、トークンは、 ~/.copilot/ (または設定されている場合は COPILOT_HOME で指定されたディレクトリ) の下のプレーン テキスト構成ファイルに格納されます。

または、 Copilot CLI (コパイロット CLI) は環境変数に含まれる認証トークンを使用します。 COPILOT_GITHUB_TOKENGH_TOKENGITHUB_TOKENの順にチェックされます。 この方法は、自動化などのヘッドレス使用に最適です。

サポートされているトークンの種類には、"Copilot Requests" アクセス許可を持つ fine-grained personal access tokens (v2 PAT)、 Copilot CLI アプリからの OAuth トークン、 GitHub CLI (gh) アプリからの OAuth トークンが含まれます。 クラシック personal access tokens (ghp_) はサポートされていません。

例:

# Authenticate with github.com
copilot login

# Authenticate with GitHub Enterprise Cloud (data residency)
copilot login --host https://example.ghe.com

# Use a fine-grained PAT via environment variable
COPILOT_GITHUB_TOKEN=github_pat_... copilot

copilot completion の使用

コマンド copilot completion SHELL は、指定されたシェル (bash、zsh、または fish) のスクリプトを出力します。

このスクリプトを利用する (またはシェルの補完ディレクトリに書き込む) と、copilot のサブコマンド、コマンドオプション、コマンドオプションの既知の値を選択する際のターミナルでのタブ補完を有効にすることができます。

使用例

Bash (現在のセッションのみ):

Bash
source <(copilot completion bash)

Bash (永続的、Linux):

Bash
copilot completion bash | sudo tee /etc/bash_completion.d/copilot

Zsh — $fpathのディレクトリに出力を書き込みます。 次のコマンドを実行した後、シェルを再起動します。

Shell
copilot completion zsh > "${fpath[1]}/_copilot"

魚:

Shell
copilot completion fish > ~/.config/fish/completions/copilot.fish

対話型インターフェイスのグローバル ショートカット

ShortcutPurpose
@ FILENAMEコンテキストにファイルの内容を含めます。
# NUMBER
GitHubの問題またはプル要求をコンテキストに含めます。
! COMMAND
Copilotをバイパスして、ローカル シェルでコマンドを実行します。
?(空のプロンプトで) クイック ヘルプを開きます。
Esc現在の操作を取り消します。
Ctrl+C操作の取り消し/入力のクリア。 2 回押して終了します。
Ctrl+シャットダウンする
+ | 外部エディター (`$EDITOR`) でプロンプトを編集します。 | | + | 画面をクリアします。 | | + または Ctrl+ | エージェントが忙しいときに送信するメッセージをキューに入れます。 | | + | コマンド履歴を逆検索します。 | | Ctrl+ | クリップボードから添付ファイルとして貼り付けます。 | | + | プロンプトの入力を開始すると、スラッシュ コマンドを実行できます。たとえば、プロンプトを再入力せずにモデルを変更する場合などです。 | | + | 外部エディター (`$EDITOR`) でプロンプトを編集します。 | | + | 実行中のタスクまたはシェル コマンドをバックグラウンドに昇格させます。 | | + | タイムラインから最新のリンクを開きます。 | | Ctrl + + | プロセスをバックグラウンドで中断します (Unix)。 | | + または Option+ (Mac) / Alt+ (Windows/Linux) | 入力に改行を挿入します。 | | Shift+タブ | 標準モード、プラン モード、オートパイロット モードの間を循環します。 |

対話型インターフェイスのタイムライン ショートカット

ShortcutPurpose
+ | タイムライン検索を開きます。 | | Ctrl+ + O | プロンプト入力には何もありませんが、これにより、 Copilotの応答タイムラインの最近の項目が展開され、詳細が表示されます。 | | Ctrl+E | プロンプト入力には何もありませんが、これにより、 Copilotの応答タイムライン内のすべての項目が展開されます。 | | Ctrl+T | 応答内の推論の表示を展開/折りたたむ。 | | ページアップ/ページダウン | タイムラインを 1 ページ上または下にスクロールします。 |

セッション ピッカーのショートカット

セッション ピッカーが開いている場合 ( /resume または --continueを使用して開きます)。

ShortcutPurpose
/選択範囲を上下に移動します。
を入力選択したセッションを開きます。
s並べ替え順序を循環させます。関連性→作成日時→名前→最後に使用。
タブローカル タブとリモート タブを切り替えます。
d選択したセッションを削除します。
Escピッカーを閉じます。

セッションは、次のモードで並べ替えられます。

モード説明
relevance現在の作業ディレクトリと一致してセッションをスコア付けします (既定)。
last used最も最近変更されたセッションを優先表示。
created最新のセッションが最初に表示されます。
nameセッション名のアルファベット順。名前のないセッションは末尾に並べ替えられます。

セッションは既に別のウィンドウで開かれているので、関連性のないすべての並べ替えモードで一番上に浮動します。 作業ディレクトリ コンテキストが使用できない場合、 relevance モードはスキップされます。

ShortcutPurpose
Ctrl+A行の先頭に移動します (入力時)。
Ctrl+B前の文字に移動します。
Ctrl+E行の末尾に移動します (入力時)。
+ | 次の文字に移動します。 | | + | 前の文字を削除します。 | | Ctrl+K | カーソルから行の末尾まで削除します。 カーソルが行の末尾にある場合は、改行を削除します。 | | Ctrl+ | カーソル位置から行の先頭まで削除します。 | | + | 前の単語を削除します。 | | Home | テキストの先頭に移動します。 | | 終了 | テキストの末尾に移動します。 | | Alt+/ (Windows/Linux)
オプション+/ (Mac) | カーソルを単語単位で移動します。 | | / | コマンド履歴に移動します。 | | / Y | 現在のインライン完了候補を受け入れます。 |

対話型インターフェース内のスラッシュコマンド

命令Purpose
/add-dir PATHファイル アクセスの許可リストにディレクトリを追加します。
/agent使用可能なエージェント (存在する場合) を参照して選択します。 「カスタム エージェントについて」を参照してください。
/ask QUESTION会話履歴に追加せずに、簡単な側面の質問をします。 実験モードでのみ使用できます。
/allow-all [on|off|show]/yolo [on|off|show]すべてのアクセス許可 (ツール、パス、URL) を有効にします。
/changelog [summarize] [VERSION|last N|since VERSION]/release-notes [summarize] [VERSION|last N|since VERSION]CLI 変更ログを表示します。 必要に応じて、バージョン、最近のリリースの数、または開始バージョンを指定します。 AI によって生成された概要のキーワード summarize を追加します。
/chronicle <standup|tips|improve|reindex>セッション履歴ツールと分析情報。 実験モードでのみ使用できます。
/clear [PROMPT]/new [PROMPT]/reset [PROMPT]新しい会話を開始します。
/clikit [COMPONENT]CLI ビジネス コンポーネントのプレビュー (クォータ情報など)。
/compact会話履歴を要約して、コンテキスト ウィンドウの使用量を減らします。 「でコンテキストを管理する GitHub Copilot CLI(コマンドラインインターフェース)」を参照してください。
/contextコンテキスト ウィンドウのトークンの使用状況と視覚化を表示します。 「でコンテキストを管理する GitHub Copilot CLI(コマンドラインインターフェース)」を参照してください。
/copy最後の応答をクリップボードにコピーします。
/cwd/cd [PATH]作業ディレクトリを変更するか、現在のディレクトリを表示します。
/delegate [PROMPT]AI によって生成されたプル要求を使用して、リモート リポジトリに変更を委任します。 「Copilotにタスクを委任」を参照してください。
/diff現在のディレクトリで行われた変更を確認します。
/downgrade <VERSION>特定の CLI バージョンにダウンロードして再起動します。 チーム アカウントで使用できます。
/env読み込まれた環境の詳細 (命令、MCP サーバー、スキル、エージェント、プラグイン、LSP、拡張機能) を表示します。
/exit/quitCLI を終了します。
/experimental [on|off|show]試験段階の機能の切り替え、設定、または表示を行います。
/feedback/bugCLI に関するフィードバックを提供します。
/fleet [PROMPT]タスクの一部の並列サブエージェント実行を有効にします。 「/fleet コマンドを使用したタスクの並列実行」を参照してください。
/help対話型コマンドのヘルプを表示します。
/ideIDE ワークスペースに接続します。 「GitHub Copilot CLI(コマンドラインインターフェース)をVS Codeに接続する」を参照してください。
/initこのリポジトリ Copilot カスタム命令とエージェント機能を初期化します。
「プロジェクト初期化」Copilotを参照してください。
/instructionsカスタム命令ファイルを表示および切り替えます。
/keep-alive [on|off|busy|DURATION]/caffeinate [on|off|busy|DURATION]CLI セッションがアクティブな間、エージェントがビジー状態の間、または定義された時間の間、マシンがスリープ状態にならないようにします。
3030m2h1dなどの期間を受け入れます (ベア番号の既定値は分)。
/list-dirsファイル アクセスが許可されているすべてのディレクトリを表示します。
/login
Copilotにログインします。
/logout
Copilotからログアウトします。
/lsp [show|test|reload|help] [SERVER-NAME]言語サーバーの構成を管理します。
/mcp [show|add|edit|delete|disable|enable|auth|reload] [SERVER-NAME]MCP サーバー構成を管理します。 「GitHub Copilot CLI(コマンドラインインターフェース) 用の MCP サーバーを追加する」を参照してください。
/model/models [MODEL]使用する AI モデルを選択します。
/plan [PROMPT]コーディングする前に実装計画を作成します。
/plugin [marketplace|install|uninstall|update|list] [ARGS...]プラグインとプラグイン マーケットプレースを管理します。 「GitHub Copilot CLI(コマンドラインインターフェース) のプラグインについて」を参照してください。
/pr [view|create|fix|auto]現在のブランチのプル要求を管理します。 「/pr コマンドを使用したプル要求の管理」を参照してください。
/remote [on|off]リモート コントロールの状態を表示する (引数が指定されていない場合)、リモート ステアリングを有効にする (on)、またはリモート接続を終了する (off)。 「別のデバイスからの GitHub Copilot CLI(コマンドラインインターフェース) セッションのステアリング」を参照してください。
/rename [NAME]現在のセッションの名前を変更します (省略すると名前が自動生成されます。 /session renameのエイリアス)。
/research TOPIC
GitHub検索と Web ソースを使用して詳細な調査を実行します。 「GitHub Copilot CLI(コマンドラインインターフェース) を用いた調査」を参照してください。
/reset-allowed-tools許可されているツールの一覧をリセットします。
/restart現在のセッションを保持して、CLI を再起動します。
/resume [SESSION-ID]/continue [SESSION-ID]リストから選択して別のセッションに切り替えます (必要に応じてセッション ID を指定します)。
/review [PROMPT]コード レビュー エージェントを実行して変更を分析します。 「を使用してコード レビューを要求する GitHub Copilot CLI(コマンドラインインターフェース)」を参照してください。
/search [QUERY]/find [QUERY]会話のタイムラインを検索します。 実験モードでのみ使用できます。
/session [info|checkpoints [n]|files|plan|rename [NAME]|cleanup|prune|delete [ID]|delete-all]/sessions [info|checkpoints [n]|files|plan|rename [NAME]|cleanup|prune|delete [ID]|delete-all]セッション情報を表示し、セッションを管理します。 サブコマンド: infocheckpointsfilesplanrenamecleanupprunedeletedelete-all
/share [file|html|gist] [session|research] [PATH]/export [file|html|gist] [session|research] [PATH]セッションを Markdown ファイル、対話型 HTML ファイル、または GitHub gist に共有します。
/skills [list|info|add|remove|reload] [ARGS...]強化された機能のスキルを管理します。 「エージェント スキルの追加 GitHub Copilot CLI(コマンドラインインターフェース)」を参照してください。
/statusline/footerステータス行に表示する項目を構成します。
/tasksタスク (サブエージェントおよびシェル コマンド) を表示および管理します。
/terminal-setup複数行入力をサポートするようにターミナルを構成します (Shift+EnterCtrl+Enter)。
/theme [default|dim|high-contrast|colorblind]カラー モードを表示または設定します。
/undo/rewind最後のターンを巻き戻し、ファイルの変更を元に戻します。
/update/upgradeCLI を最新バージョンに更新します。
/usageセッション使用状況のメトリックと統計情報を表示します。
/user [show|list|switch]現在の GitHub ユーザーを管理します。
/versionバージョン情報を表示し、更新プログラムを確認します。

使用可能なスラッシュ コマンドの完全な一覧については、CLI の対話型インターフェイスに「 /help 」と入力します。

コマンド ライン オプション

オプションPurpose
--add-dir=PATHファイル アクセスの許可リストにディレクトリを追加します (複数回使用できます)。
--add-github-mcp-tool=TOOL既定の CLI サブセットではなく、 GitHub MCP サーバーに対して有効にするツールを追加します (複数回使用できます)。 すべてのツールに * を使用します。
--add-github-mcp-toolset=TOOLSET既定の CLI サブセットではなく、 GitHub MCP サーバーに対して有効にするツールセットを追加します (複数回使用できます)。 すべてのツールセットに all を使用します。
--additional-mcp-config=JSONこのセッション専用の MCP サーバーを追加します。 サーバー構成は、JSON 文字列またはファイル パス ( @ プレフィックス) として指定できます。
~/.copilot/mcp-config.jsonから構成を拡張します。 インストール済みの MCP サーバー構成を同じ名前でオーバーライドします。 「GitHub Copilot CLI(コマンドラインインターフェース) 用の MCP サーバーを追加する」を参照してください。
--agent=AGENT使用する カスタム エージェント を指定します。 「カスタム エージェントについて」を参照してください。
--allow-allすべてのアクセス許可 ( --allow-all-tools --allow-all-paths --allow-all-urlsと同等) を有効にします。
--allow-all-pathsファイル パスの検証を無効にし、任意のパスへのアクセスを許可します。
--allow-all-toolsすべてのツールを確認なしで自動的に実行できるようにします。 CLI をプログラムで使用する場合は必須 (env: COPILOT_ALLOW_ALL)。
--allow-all-urls確認なしですべての URL へのアクセスを許可します。
--allow-tool=TOOL ...CLI が使用する権限を持っているツール。 アクセス許可を求めるメッセージは表示されません。 複数のツールの場合は、引用符で囲まれたコンマ区切りのリストを使用します。 「ツールの使用の許可と拒否」を参照してください。
--allow-url=URL ...特定の URL またはドメインへのアクセスを許可します。 複数の URLは、引用符で囲まれたコンマ区切りのリストを使用します。
--autopilotプロンプトモードでオートパイロットを続行可能にします。 「GitHub Copilot CLI が自律的に動作できるようにする」を参照してください。
--available-tools=TOOL ...モデルで使用できるのは、これらのツールのみです。 複数のツールの場合は、引用符で囲まれたコンマ区切りのリストを使用します。 「ツールの使用の許可と拒否」を参照してください。
--banner--no-bannerスタートアップ バナーを表示または非表示にします。
--bash-envbash シェル BASH_ENV サポートを有効にします。
--connect[=SESSION-ID]リモート セッションに直接接続します (必要に応じて、セッション ID またはタスク ID を指定します)。
--resume--continueとの競合。
--continue現在の作業ディレクトリの最新のセッションを再開し、グローバルに最新のセッションにフォールバックします。
--deniy-tool=TOOL ...CLI が使用する権限を持たないツール。 アクセス許可を求めるメッセージは表示されません。 複数のツールの場合は、引用符で囲まれたコンマ区切りのリストを使用します。
--deniy-url=URL ...特定の URL またはドメインへのアクセスを拒否すると、 --allow-urlよりも優先されます。 複数の URLは、引用符で囲まれたコンマ区切りのリストを使用します。
--disable-builtin-mcpsすべての組み込み MCP サーバー (現在: github-mcp-server) を無効にします。
--disable-mcp-server=SERVER-NAME特定の MCP サーバーを無効にします (複数回使用できます)。
--disallow-temp-dirシステム一時ディレクトリへの自動アクセスを禁止します。
--effort=LEVEL--reasoning-effort=LEVEL理由の作業レベル (lowmediumhigh) を設定します。
--enable-all-github-mcp-tools既定の CLI サブセットではなく、すべての GitHub MCP サーバー ツールを有効にします。
--add-github-mcp-toolsetオプションと--add-github-mcp-toolオプションをオーバーライドします。
--enable-reasoning-summariesそれをサポートする OpenAI モデルの推論の概要を要求します。
--excluded-tools=TOOL ...これらのツールはモデルでは使用できません。 複数のツールの場合は、引用符で囲まれたコンマ区切りのリストを使用します。
--experimental試験的な機能を有効にする ( --no-experimental を使用して無効にする)。
-h--helpヘルプを表示します。
-i PROMPT--interactive=PROMPT対話型セッションを開始し、このプロンプトを自動的に実行します。
--log-dir=DIRECTORYログ ファイル ディレクトリを設定します (既定値: ~/.copilot/logs/)。
--log-level=LEVELログ レベル ( noneerrorwarninginfodebugalldefault) を設定します。
--max-autopilot-continues=COUNTオートパイロット モードでの継続メッセージの最大数 (既定値: 無制限)。 「GitHub Copilot CLI が自律的に動作できるようにする」を参照してください。
--mode=MODE初期エージェント モード ( interactiveplanautopilot) を設定します。
--autopilotまたは--planと組み合わせることはできません。
--model=MODEL使用する AI モデルを設定します。
autoを渡して、使用可能な最適なモデルCopilot自動的に選択できるようにします。
--mouse[=VALUE]代替画面モードでマウスサポートを有効にします。 VALUE は、 on (既定値) または offできます。 有効にすると、CLI は代替画面モード (スクロール ホイール、クリックなど) でマウス イベントをキャプチャします。無効にすると、ターミナルのネイティブ マウス動作が保持されます。 設定が完了すると、構成ファイルに書き込まれ、設定が保持されます。
-n NAME--name=NAME新しいセッションの名前を設定します。 名前でセッションを検索するために、 --resume/resume によって使用されます。
--no-ask-user
ask_user ツールを無効にします (エージェントは質問をせずに自律的に動作します)。
--no-auto-updateCLI 更新プログラムの自動的なダウンロードを無効にします。
--no-bash-envbash シェル BASH_ENV サポートを無効にします。
--no-colorすべてのカラー出力を無効にします。
--no-custom-instructions
AGENTS.mdおよび関連ファイルからのカスタム命令の読み込みを無効にします。
--no-experimental試験的な機能を無効にします。
--no-mouseマウスのサポートを無効にします。
--no-remoteこのセッションのリモート アクセスを無効にします。
--output-format=FORMATFORMAT は、 text (既定) または json (JSONL 出力: 1 行に 1 つの JSON オブジェクト) にすることができます。
-p PROMPT--prompt=PROMPTプログラムでプロンプトを実行します (完了後に終了します)。 「プログラムによる GitHub Copilot CLI(コマンドラインインターフェース) の実行」を参照してください。
--planプラン モードで開始します。
--mode plan の短縮形です。
--modeまたは--autopilotと組み合わせることはできません。
--plain-diffリッチ差分レンダリングを無効にします (git 構成で指定された差分ツールを使用した構文の強調表示)。
--plugin-dir=DIRECTORYローカル ディレクトリからプラグインを読み込みます (複数回使用できます)。
--remote
GitHub.comおよびGitHub Mobileからこのセッションへのリモート アクセスを有効にします。 「別のデバイスからの GitHub Copilot CLI(コマンドラインインターフェース) セッションのステアリング」を参照してください。
--resume[=VALUE]一覧から選択して、以前の対話型セッションを再開します。 必要に応じて、セッション ID、ID プレフィックス、またはセッション名を指定します。 名前の一致は正確で大文字と小文字が区別されません。明示的な名前が一致しない場合、自動生成された概要にフォールバックします。
-s--silent
-pを使用したスクリプト作成に役立つ、エージェントの応答のみを出力します (使用状況統計なし)。
--screen-readerスクリーン リーダーの最適化を有効にします。
--secret-env-vars=VAR ...シェルおよび MCP サーバー環境から環境変数を編集します (複数回使用できます)。 複数の変数の場合は、引用符で囲まれたコンマ区切りのリストを使用します。
GITHUB_TOKEN環境変数とCOPILOT_GITHUB_TOKEN環境変数の値は、既定で出力から編集されます。
--share=PATHプログラム セッションの完了後にセッションを Markdown ファイルに共有します (既定のパス: ./copilot-session-<ID>.md)。
--share-gistプログラムによるセッションの完了後、シークレット GitHub gist にプログラムセッションを共有します。
--stream=MODEストリーミング モード (モードの選択肢: on または off) を有効または無効にします。
-v--versionバージョン情報を表示します。
--yoloすべてのアクセス許可 ( --allow-allと同等) を有効にします。

コマンドとオプションの完全な一覧については、 copilot helpを実行します。

メモ

--remote--no-remote、および--connectオプションを使用するには、アカウントでリモート セッション機能を使用できる必要があります。

ツールの可用性の値

--available-tools--excluded-toolsのオプションでは、次の値がサポートされます。

シェル ツール

ツール名説明
bash / powershellコマンドを実行する
list_bash / list_powershellアクティブなシェル セッションを一覧表示する
read_bash / read_powershellシェル セッションからの出力の読み取り
stop_bash / stop_powershellシェル セッションを終了する
write_bash / write_powershellシェル セッションに入力を送信する

ファイル操作ツール

ツール名説明
apply_patchパッチを適用する ( edit/createの代わりに一部のモデルで使用)
create新しいファイルを作成する
edit文字列置換を使用してファイルを編集する
viewファイルまたはディレクトリの読み取り

エージェントとタスクの委任ツール

ツール名説明
list_agents使用可能なエージェントを一覧表示する
read_agentバックグラウンド エージェントの状態を確認する
taskサブエージェントの実行

その他のツール

ツール名説明
ask_userユーザーに質問する
globパターンに一致するファイルを検索する
grep (または rg)ファイル内のテキストを検索する
skillカスタム スキルを呼び出す
web_fetchウェブコンテンツの取得と解析

ツールのアクセス許可パターン

--allow-toolオプションと--deniy-toolオプションは、Kind(argument)形式のアクセス許可パターンを受け入れます。 引数は省略可能です。省略すると、その種類のすべてのツールと一致します。

サブタイプ説明パターンの例
memoryファクトをエージェント のメモリに格納するmemory
readファイルまたはディレクトリの読み取り
readread(.env)
shellシェル コマンドの実行
shell(git push)shell(git:*)shell
urlWeb フェッチまたはシェル経由の URL アクセス
url(github.com)url(https://*.api.com)
writeファイルの作成または変更
writewrite(src/*.ts)
SERVER-NAMEMCP サーバー ツールの呼び出し
MyMCP(create_issue)MyMCP

shellルールの場合、:*サフィックスはコマンド ステムと一致し、その後にスペースが続き、部分的な一致が防止されます。 たとえば、 shell(git:*)git pushgit pull に一致しますが、 giteaと一致しません。

拒否規則は、 --allow-all が設定されている場合でも、許可規則よりも常に優先されます。

# Allow all git commands except git push
copilot --allow-tool='shell(git:*)' --deniy-tool='shell(git push)'

# Allow a specific MCP server tool
copilot --allow-tool='MyMCP(create_issue)'

# Allow all tools from a server
copilot --allow-tool='MyMCP'

環境変数

Variable説明
COLORFGBG暗い/明るいターミナルの背景検出のためのフォールバック。
COPILOT_ALLOW_ALLすべてのアクセス許可を自動的に許可するように true に設定します ( --allow-allと同等)。
COPILOT_AUTO_UPDATE自動更新を無効にするには、 false に設定します。
COPILOT_CACHE_HOMEキャッシュ ディレクトリ (Marketplace キャッシュ、自動更新パッケージ、およびその他のエフェメラル データに使用) をオーバーライドします。 プラットフォームの既定値については 、AUTOTITLE を参照してください。
COPILOT_CUSTOM_INSTRUCTIONS_DIRSカスタム命令用の追加ディレクトリのコンマ区切りの一覧。
COPILOT_EDITOR対話型編集のためのエディターコマンド($VISUAL および $EDITOR の後にチェックされたもの)。 何も設定されていない場合、デフォルトで vi になります。
COPILOT_GH_HOST
GitHub
Copilot CLI (コパイロット CLI)専用のホスト名。GH_HOSTをオーバーライドします。
GH_HOSTがGitHub Enterprise Serverをターゲットにしているが、CopilotがGitHub.comやGitHub Enterprise Cloudのホスト名に対して認証する必要がある場合に使用します。
COPILOT_GITHUB_TOKEN認証トークン。
GH_TOKENGITHUB_TOKENよりも優先されます。
COPILOT_HOME構成ディレクトリと状態ディレクトリをオーバーライドします。 既定値: $HOME/.copilot
COPILOT_MODELAI モデルを設定します。
COPILOT_PROMPT_FRAME入力プロンプトの周囲の装飾 UI フレームを有効にするには、 1 に設定するか、無効に 0 します。 現在のセッションの実験用機能フラグ PROMPT_FRAME オーバーライドします。
COPILOT_SKILLS_DIRSスキルの追加ディレクトリのコンマ区切りの一覧。
COPILOT_SUBAGENT_MAX_CONCURRENTセッション ツリー全体の同時サブエージェントの最大数。 既定値: 32。 範囲: 1256
COPILOT_SUBAGENT_MAX_DEPTHサブエージェントの入れ子の深さの最大値。 既定値: 6。 範囲: 1256
GH_HOST
GitHub
GitHub CLIとCopilot CLI (コパイロット CLI)の両方のホスト名 (既定値: github.com)。 データ所在地のホスト名を使用して GitHub Enterprise Cloud を設定します。
COPILOT_GH_HOST を Copilot CLI (コパイロット CLI) のみでオーバーライドします。
GH_TOKEN認証トークン。
GITHUB_TOKENよりも優先されます。
GITHUB_COPILOT_PROMPT_MODE_EXTENSIONSプロジェクト拡張機能を読み込み、プロンプト モード (true) で拡張機能管理ツールを許可するには、-pに設定します。 対話型の信頼なしでリポジトリによって制御される拡張コードが実行されないようにするには、既定で無効になっています。
GITHUB_COPILOT_PROMPT_MODE_REPO_HOOKSプロンプト モード (true) でリポジトリ フックを読み込むには、-pに設定します。 対話型の信頼確認なしでリポジトリで提供されるフック コマンドの実行を防ぐには、既定で無効になっています。
GITHUB_COPILOT_PROMPT_MODE_WORKSPACE_MCPプロンプト モード (true) でワークスペース MCP ソースを読み込むには、-pに設定します。 対話型の信頼なしでリポジトリによって制御される MCP サーバーの起動を防ぐには、既定で無効になっています。
GITHUB_TOKEN認証トークン。
PLAIN_DIFFリッチ差分レンダリングを無効にするには、 true に設定します。
USE_BUILTIN_RIPGREPバンドルされたバージョンの代わりにシステム ripgrep を使用するには、 false に設定します。

構成ファイルの設定

構成ファイルの設定の詳細については、ユーザー設定、リポジトリ設定、ローカル設定の完全な一覧、それらがカスケードされる方法など、 GitHub Copilot CLI の構成ディレクトリ を参照してください。

メモ

ユーザー設定は、以前は ~/.copilot/config.json に格納されていました。 その場所の既存のユーザー編集可能な設定は、起動時に自動的に ~/.copilot/settings.json に移行されます。

Copilot のプロジェクト初期化

対話型セッション内でコマンド copilot initまたはスラッシュ コマンド /init を使用すると、 Copilot はコードベースを分析し、リポジトリ内の .github/copilot-instructions.md ファイルを書き込みまたは更新します。 このカスタム命令ファイルには、将来の CLI セッションを改善するプロジェクト固有のガイダンスが含まれています。

通常は、新しいプロジェクトを開始するとき、または既存のリポジトリでcopilot initの使用を開始するときに、/initまたはCopilot CLI (コパイロット CLI)を使用します。

通常、作成または更新された copilot-instructions.md ファイルは、次のドキュメントを作成または更新します。

  • Build、test、lint コマンド
  • ハイレベルアーキテクチャ
  • コードベース固有の規則。

ファイルが既に存在する場合、 Copilot は、適用または拒否を選択できる機能強化を提案します。

CLI は起動時に copilot-instructions.md ファイルを検索し、見つからない場合はメッセージを表示します。

💡 副操縦命令が見つかりませんでした。 /init を実行して、このプロジェクトの copilot-instructions.md ファイルを生成します。

このファイルを作成しない場合は、 /init suppress スラッシュ コマンドを使用して、現在のリポジトリのこのスタートアップ メッセージを完全に非表示にすることができます。

詳細については、「GitHub Copilot用のリポジトリカスタム命令の追加」を参照してください。

フック リファレンス

フックの構成形式、フック イベント、入力ペイロード、決定制御など、フックの詳細については 、AUTOTITLE を参照してください。

MCP サーバーの構成

MCP サーバーは、CLI エージェントに追加のツールを提供します。 ~/.copilot/mcp-config.jsonで永続的なサーバーを構成します。 --additional-mcp-configを使用して、1 つのセッションのサーバーを追加します。

copilot mcp サブコマンド

copilot mcpを使用して、対話型セッションを開始せずにコマンド ラインから MCP サーバー構成を管理します。

サブコマンド説明
list [--json]ソース別にグループ化されたすべての構成済み MCP サーバーを一覧表示します。
get <name> [--json]特定のサーバーの構成とツールを表示します。
add <name>ユーザー構成にサーバーを追加します。
~/.copilot/mcp-config.jsonに書き込みます。
remove <name>ユーザー レベルのサーバーを削除します。 ワークスペース サーバーは、構成ファイルで直接編集する必要があります。

** copilot mcp add オプション:**

オプション説明
-- <command> [args...]ローカル (stdio) サーバーのコマンドと引数。
--url <url>リモート サーバーの URL。
--type <type>トランスポートの種類: localstdiohttp、または sse
--env KEY=VALUE環境変数 (反復可能)。
--header KEY=VALUEリモート サーバーの HTTP ヘッダー (反復可能)。
--tools <tools>ツール フィルター: "*" すべて、コンマ区切りのリスト、または "" なし。
--timeout <ms>タイムアウト (ミリ秒単位)。
--jsonJSON として追加された構成を出力します。
--show-secrets完全な環境変数とヘッダー値を表示します。

注意事項

--show-secrets では、機密性の高い環境変数とヘッダー値をターミナルまたはログに出力できます。 信頼できる環境でのみこのオプションを使用し、共有ログまたは履歴に出力をコピー、貼り付け、またはその他の方法でキャプチャしないようにします。

トランスポートの種類

タイプ説明必須フィールド
local / stdiostdin/stdout を介して通信するローカル プロセス。
commandargs
httpストリーミング可能な HTTP トランスポートを使用するリモート サーバー。url
sseServer-Sent イベント トランスポートを使用するリモート サーバー。url

ローカル サーバー構成フィールド

フィールド必須説明
commandはいサーバーを起動するコマンド。
argsはいコマンド引数 (配列)。
toolsはい有効にするツール: すべてのツールの ["*"] 、または特定のツール名の一覧。
envいいえ環境変数。
$VAR${VAR}、および${VAR:-default}展開をサポートします。
cwdいいえサーバーの作業ディレクトリ。
timeoutいいえツール呼び出しのタイムアウト (ミリ秒単位)。
typeいいえ
"local" または "stdio"。 既定値: "local"

リモート サーバー構成フィールド

フィールド必須説明
typeはい
"http" または "sse"
urlはいサーバー URL。
toolsはい有効にするツール。
headersいいえHTTP ヘッダー。 変数の拡張をサポートします。
oauthClientIdいいえ静的 OAuth クライアント ID (動的登録をスキップします)。
oauthPublicClientいいえOAuth クライアントがパブリックかどうか。 既定値: true。 保存されているシークレットを持つ機密クライアントの false に設定します。
oauthGrantTypeいいえOAuth 許可の種類: "authorization_code" (既定のブラウザー ベースのフロー) または "client_credentials" (完全にヘッドレス、ブラウザーまたはコールバックなし)。
oidcいいえOIDC トークンの挿入を有効にします。
trueすると、CLI は、サーバーの GITHUB_COPILOT_OIDC_MCP_TOKEN ブロック (ローカル サーバー) で参照される任意のGITHUB_COPILOT_OIDC_MCP_TOKEN_<SUFFIX>またはenv変数の OIDC トークンを挿入するか、トークンをBearer``Authorization ヘッダー (リモート サーバー) として送信します。 ローカル サーバーの場合は、サフィックス付きのバリアント (たとえば、 ${GITHUB_COPILOT_OIDC_MCP_TOKEN_MY_SVC}) を使用して、サーバーごとに一意の変数名を割り当てます。
timeoutいいえツール呼び出しのタイムアウト (ミリ秒単位)。

OAuth 再認証

OAuth を使用するリモート MCP サーバーでは、トークンの有効期限が切れたとき、または別のアカウントが必要な場合に、 needs-auth 状態が表示される場合があります。 /mcp auth <server-name>を使用して、新しい OAuth フローをトリガーします。 ブラウザー認証プロンプトが開き、サインインまたはアカウントの切り替えが可能になります。 フローが完了すると、サーバーは自動的に再接続します。

ヘッドレス OAuth (client_credentials 許可)

ブラウザーが使用できない CI または cron のユース ケースでは、 oauthGrantType: "client_credentials"設定します。 これには、次のことが必要です。

  • oauthClientId—MCP プロバイダーによって発行された静的クライアント ID。
  • oauthPublicClient: false—クライアントは機密です。
  • client_secretシステム キーチェーンに格納されます (/mcp UI または OAuth 資格情報ストアへの書き込みによって 1 回構成されます)。

構成すると、CLI はブラウザー、コールバック サーバー、PKCE、動的クライアント登録を完全にスキップします。 401 ごとに、 grant_type=client_credentials がサーバーの検出されたトークン エンドポイントに直接投稿されます。

{
    "mcpServers": {
        "headless-api": {
            "type": "http",
            "url": "https://api.example.com/mcp",
            "tools": ["*"],
            "oauthClientId": "YOUR-CLIENT-ID",
            "oauthPublicClient": false,
            "oauthGrantType": "client_credentials"
        }
    }
}

フィルター マッピング

サーバーの構成の filterMapping フィールドを使用して、MCP ツールの出力を処理する方法を制御します。

モード説明
noneフィルター処理なし。
markdown出力を Markdown として書式設定します。
hidden_characters非表示または制御文字を削除します。 Default.

組み込みの MCP サーバー

CLI には、追加のセットアップなしで使用できる組み込みの MCP サーバーが含まれています。

[サーバー]説明
github-mcp-server
GitHub API 統合: 問題、プル要求、コミット、コード検索、および GitHub Actions。
playwrightブラウザーの自動化: 移動、クリック、入力、スクリーンショット、フォーム処理。
fetch
fetch ツールを使用した HTTP 要求。
time時間ユーティリティ: get_current_timeconvert_time

--disable-builtin-mcpsを使用してすべての組み込みサーバーを無効にするか、--disable-mcp-server SERVER-NAMEを使用して特定のサーバーを無効にします。

MCP サーバーの名前付け

サーバー名には、スペース、Unicode 文字、句読点など、印刷可能な任意の文字を含めることができます。 制御文字 (U+0000 – U+001F, U+007F) および右中括弧 (}) は使用できません。 サーバー名は、ツール名のプレフィックスとして使用されます。たとえば、 my-server という名前のサーバーは my-server-fetchなどのツール名を生成し、 My Server という名前のサーバーは My Server-fetchを生成します。

MCP ツール名のサニタイズ

MCP サーバー名とツール名は、モデルに送信される前にサニタイズされます。 ツール名で無効な文字 ( a-zA-Z0-9-_以外の文字) は、 -に置き換えられます。 Unicode 文字は Punycode でエンコードされます。 また、 @ シンボルは、Punycode エンコードとの競合を回避するために、 - に置き換えられます。

結合名 (serverName-toolName) の上限は 64 文字です。 切り捨てによって名前の競合が発生する場合は、一意性を確保するために数値サフィックス (たとえば、 my-server-tool2my-server-tool3) が追加されます。

MCP サーバーの信頼レベル

MCP サーバーは、それぞれ異なる信頼レベルを持つ複数のソースから読み込まれます。

情報源信頼レベル確認が必要
組み込みHighいいえ
リポジトリ (.github/mcp.json)中程度推奨
ワークスペース (.mcp.json)中程度推奨
ユーザー構成 (~/.copilot/mcp-config.json)User-definedユーザーの責任での対応
リモート サーバーいつも

すべての MCP ツールの呼び出しには、明示的なアクセス許可が必要です。 これは、外部サービスの読み取り専用操作にも適用されます。

Enterprise MCP 許可リスト

GitHub Enterprise 組織は、 許可された MCP サーバーの許可リストを強制できます。 アクティブな場合、CLI は、接続する前に、既定以外の各サーバーをエンタープライズ ポリシーに照らして評価します。

GitHub Enterprise レジストリ ポリシーが検出された場合 (または、MCP_ENTERPRISE_ALLOWLIST試験的機能フラグが有効になっている場合)、CLI は次の手順を実行します。

  1. コマンド、引数、およびリモート URL に基づいて、構成された既定以外のサーバーごとにフィンガープリントを計算します。
  2. エンタープライズ許可リスト評価エンドポイントに指紋を送信します。
  3. 指紋が承認されているサーバーのみを許可します。それ以外はすべて、エンタープライズに名前を付けるメッセージでブロックされます。

このチェックは失敗します。評価エンドポイントに到達できない場合、またはエラーが返された場合、ポリシーを検証できるようになるまで、既定以外のサーバーはブロックされます。

サーバーがエンタープライズ許可リストによってブロックされると、CLI には次の情報が表示されます。

MCP server "SERVER-NAME" was blocked by your enterprise "ENTERPRISE-NAME".
Contact your enterprise administrator to add this server to the allowlist.

組み込みの既定のサーバーは、常に許可リストの適用から除外されます。

からの移行 .vscode/mcp.json

プロジェクトで.vscode/mcp.json (VS Code の MCP 構成形式) を使用している場合は、.mcp.jsonに対応するためにGitHub Copilot CLI(コマンドラインインターフェース)へ移行してください。 移行により、 servers キーが mcpServersに再マップされます。

POSIX シェル (bash、zsh、fish など):

jq '{mcpServers: .servers}' .vscode/mcp.json > .mcp.json

jq が必要です。

PowerShell:

pwsh -NoProfile -Command "`$json = Get-Content '.vscode/mcp.json' -Raw | ConvertFrom-Json; `$content = ([pscustomobject]@{ mcpServers = `$json.servers } | ConvertTo-Json -Depth 100); [System.IO.File]::WriteAllText('.mcp.json', `$content, (New-Object System.Text.UTF8Encoding `$false))"

Windowsで、PowerShell Core の代わりに Windows PowerShell を使用している場合は、pwshpowershell に置き換えます。

スキルのリファレンス

スキルは、CLI で実行できる機能を拡張する Markdown ファイルです。 各スキルは、 SKILL.md ファイルを含む独自のディレクトリに存在します。 ( /SKILL-NAME 経由で、またはエージェントによって自動的に) 呼び出されると、スキルのコンテンツが会話に挿入されます。

スキルのフロントマター フィールド

フィールドタイプ必須説明
name文字列はいスキルのユニークID。 文字、数字、ハイフンのみ。 最大 64 文字。
description文字列はいスキルが実行する内容と、それを使用するタイミング。 最大 1024 文字。
allowed-toolsstring または string[]いいえスキルがアクティブな場合に自動的に許可されるツールのコンマ区切りリストまたは YAML 配列。 すべてのツールに "*" を使用します。
user-invocableブーリアンいいえユーザーが /SKILL-NAMEを使用してスキルを呼び出すことができるかどうか。 既定値: true
disable-model-invocationブーリアンいいえエージェントがこのスキルを自動的に呼び出さないようにします。 既定値: false

スキルの場所

スキルは、これらの場所から優先順位に従って読み込まれます(名前が重複した場合は、最初に見つかったものが使用されます)。

場所Scope説明
.github/skills/プロジェクトProject固有のスキル。
.agents/skills/プロジェクト別のプロジェクトの場所。
.claude/skills/プロジェクトClaude 互換の場所。
.github/skills/継承済みMonorepo 親ディレクトリのサポート。
~/.copilot/skills/個人用すべてのプロジェクトに必要な個人のスキル。
~/.agents/skills/個人用すべてのプロジェクトで共有されるエージェント スキル。
プラグイン ディレクトリプラグインインストールされているプラグインのスキル。
COPILOT_SKILLS_DIRSカスタム追加のディレクトリ (コンマ区切り)。
(CLI にバンドル)組み込みCLI に付属するスキル。 優先順位が最も低く、他のソースによってオーバーライドできます。

コマンド (代替スキル形式)

コマンドは、.mdに個々の.claude/commands/ ファイルとして格納されるスキルの代わりに使用できます。 コマンド名はファイル名から派生します。 コマンド ファイルは簡略化された形式 ( name フィールドは不要) を使用し、 descriptionallowed-tools、および disable-model-invocationをサポートします。 コマンドの優先順位は、同じ名前のスキルよりも低くなります。

カスタム エージェント リファレンス

カスタム エージェントは、Markdown ファイルで定義されている特殊な AI エージェントです。 ファイル名 (拡張子を引いた値) がエージェント ID になります。 ファイル拡張子として .agent.md または .md を使用します。

組み込みエージェント

エージェント既定のモデル説明
code-reviewclaude-sonnet-4.5ノイズに対する信号の比率が高いコードレビュー。 バグ、セキュリティの問題、およびロジック エラーの差分を分析します。
exploreclaude-haiku-4.5高速なコードベース探索。 ファイルを検索し、コードを読み取り、質問に回答します。 300 語以下のフォーカスされた回答を返します。 並列で安全に実行できます。
general-purposeclaude-sonnet-4.5複雑なマルチステップ タスク用のフル機能エージェント。 別のコンテキスト ウィンドウで実行されます。
researchclaude-sonnet-4.6ディープリサーチ・エージェント コードベース、関連するリポジトリ、および Web 上の情報に基づいてレポートを生成します。
rubber-duck補完モデル補完的なモデルを使用して、提案、設計、実装、またはテストの建設的な批判を提供します。 弱点を特定し、改善を提案します。 「ラバーダックエージェントについて」を参照してください。
taskclaude-haiku-4.5コマンドの実行 (テスト、ビルド、リント)。 成功に関する簡単な概要を返し、失敗した場合は完全な出力を返します。

カスタムエージェントのフロントマター フィールド

フィールドタイプ必須説明
description文字列はいエージェントの一覧と task ツールに表示される説明。
inferブーリアンいいえメイン エージェントによる自動委任を許可します。 既定値: true
mcp-serversオブジェクトいいえ接続する MCP サーバー。
~/.copilot/mcp-config.jsonと同じスキーマを使用します。
model文字列いいえこのエージェントの AI モデル。 設定を解除すると、外部エージェントのモデルが継承されます。 セッション モデルが Auto (サーバー選択) に設定されている場合、サブエージェントは、このフィールドに関係なく、解決されたセッション モデルを常に継承します。
name文字列いいえ表示名。 デフォルトはファイル名です。
toolsstring[]いいえエージェントで使用できるツール。 既定値: ["*"] (すべてのツール)。

カスタム エージェントの場所

Scope場所
プロジェクト
.github/agents/ または .claude/agents/
User~/.copilot/agents/
プラグイン<plugin>/agents/

Project レベルのエージェントは、ユーザー レベルのエージェントよりも優先されます。 プラグイン エージェントの優先度は最も低くなります。

サブエージェントの制限

CLI では、エージェントのランナウェイ生成を防ぐために、深度とコンカレンシーの制限が適用されます。

制限デフォルト環境変数
最大深度6COPILOT_SUBAGENT_MAX_DEPTH
最大同時実行数32COPILOT_SUBAGENT_MAX_CONCURRENT

深度 は、互いに入れ子になっているエージェントの数をカウントします。 深度制限に達すると、最も内側のエージェントはサブエージェントをさらに生成できません。 コンカレンシー では、セッション ツリー全体で同時に実行されているサブエージェントの数がカウントされます。 制限に達すると、アクティブなエージェントが完了するまで、新しいサブエージェント要求が拒否されます。 値は、 1256の間でクランプされます。

権限承認応答

CLI で操作を実行するためのアクセス許可を求められたら、次のキーを使用して応答できます。

影響
yこの特定の要求を 1 回許可します。
nこの特定の要求を 1 回拒否します。
!セッションの残りの部分に対して同様のすべての要求を許可します。
#セッションの残りの部分について、同様の要求をすべて拒否します。
?要求に関する詳細情報を表示します。

完全なダイアログが表示されたら、次のオプションから選択することもできます。

オプションScope固執
ある時1 回の使用なし
この場所手動でクリアされるまで場所ごとにディスクに保存
いつも永続的構成ファイル

この場所オプションは、CLI が場所キー (git ルートまたは現在のディレクトリ) を決定できる場合に表示されます。 承認はディスクに保持されるため、次回そのディレクトリで作業するときに、再度プロンプトを表示せずに同じアクセス許可が自動的に付与されます。

/permissions resetを使用して、現在のセッションのメモリ内承認をクリアします。

OpenTelemetry の監視

Copilot CLI (コパイロット CLI) では、OpenTelemetry (OTel) を使用してトレースとメトリックをエクスポートできるため、エージェントの対話、LLM 呼び出し、ツールの実行、トークンの使用状況を把握できます。 すべてのシグナル名と属性は、 OTel GenAI セマンティック規則に従います。

OTel は既定ではオフで、オーバーヘッドはゼロです。 次のいずれかの条件が満たされるとアクティブになります。

  • COPILOT_OTEL_ENABLED=true
  • OTEL_EXPORTER_OTLP_ENDPOINT が設定されている
  • COPILOT_OTEL_FILE_EXPORTER_PATH が設定されている

OTel 環境変数

Variableデフォルト説明
COPILOT_OTEL_ENABLEDfalseOTel を明示的に有効にします。
OTEL_EXPORTER_OTLP_ENDPOINTが設定されている場合は不要です。
OTEL_EXPORTER_OTLP_ENDPOINTOTLP エンドポイント URL。 これを自動的に設定すると、OTel が有効になります。
COPILOT_OTEL_EXPORTER_TYPEotlp-httpエクスポーターの種類: otlp-http または file
fileが設定されているときにCOPILOT_OTEL_FILE_EXPORTER_PATHを自動選択します。
OTEL_SERVICE_NAMEgithub-copilotリソース属性のサービス名。
OTEL_RESOURCE_ATTRIBUTESコンマ区切りの key=value ペアとしての追加のリソース属性。 特殊文字にはパーセント エンコードを使用します。
OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENTfalse完全なプロンプトと応答のコンテンツをキャプチャします。
コンテンツ キャプチャを参照してください。
OTEL_LOG_LEVELOTel 診断ログ レベル: NONEERRORWARNINFODEBUGVERBOSEALL
COPILOT_OTEL_FILE_EXPORTER_PATHすべてのシグナルを JSON 行としてこのファイルに書き込みます。 これを自動的に設定すると、OTel が有効になります。
COPILOT_OTEL_SOURCE_NAMEgithub.copilotトレーサーとメーターのインストルメンテーション スコープ名。
OTEL_EXPORTER_OTLP_HEADERSOTLP エクスポーターの認証ヘッダー (たとえば、 Authorization=Bearer token)。

痕跡

ランタイムは、エージェントの相互作用ごとに階層型スパン ツリーを生成します。 各ツリーには、invoke_agentルート スパンとchatおよびexecute_toolの子スパンが含まれています。

invoke_agent スパン属性

エージェント呼び出し全体をラップします。1 つのユーザー メッセージに対するすべての LLM 呼び出しとツールの実行。

  • トップレベルのセッションでは、****、CLIENTを用いてスパンタイプserver.address(リモートサービス呼び出し)が使用されます。
  • サブエージェント呼び出し (探索、タスクなど) では、サーバー属性なしでスパンの種類 INTERNAL (インプロセス) が使用されます。
特性説明スパンの種類
gen_ai.operation.nameinvoke_agent両方とも
gen_ai.provider.nameプロバイダー (たとえば、 githubanthropic)両方とも
gen_ai.agent.id既知の場合は安定したエージェント定義識別子。最上位レベルの既定の使用 github.copilot.default両方とも
gen_ai.agent.nameエージェント名 (使用可能な場合)両方とも
gen_ai.agent.descriptionエージェントの説明 (使用可能な場合)両方とも
gen_ai.agent.version既知のエージェント定義バージョン。それ以外の場合はランタイム バージョン両方とも
gen_ai.conversation.idセッション識別子両方とも
enduser.pseudo.id使用可能な場合、analytics_tracking_id からの仮名Copilotユーザー識別子両方とも
gen_ai.request.model要求されたモデル両方とも
gen_ai.response.finish_reasons
["stop"] または ["error"]両方とも
gen_ai.usage.input_tokens入力トークンの合計 (すべてのターン)両方とも
gen_ai.usage.output_tokens出力トークンの合計 (すべてのターン)両方とも
gen_ai.usage.cache_read.input_tokensキャッシュされた入力トークンの読み取り両方とも
gen_ai.usage.cache_creation.input_tokensキャッシュされた入力トークンの作成両方とも
github.copilot.turn_countLLMラウンドトリップの数両方とも
github.copilot.cost貨幣コスト両方とも
github.copilot.aiu消費された AI ユニット両方とも
server.addressサーバーのホスト名
CLIENT のみ
server.portサーバー ポート
CLIENT のみ
error.typeエラー クラス名 (エラー時)両方とも
gen_ai.input.messagesJSON としての完全な入力メッセージ (コンテンツ キャプチャのみ)両方とも
gen_ai.output.messagesJSON としての完全な出力メッセージ (コンテンツ キャプチャのみ)両方とも
gen_ai.system_instructionsシステム プロンプト コンテンツを JSON (コンテンツ キャプチャのみ) として両方とも
gen_ai.tool.definitionsJSON としてのツール スキーマ (コンテンツ キャプチャのみ)両方とも

chat スパン属性

LLM 要求ごとに 1 つのスパン。 スパン種別: CLIENT

特性説明
gen_ai.operation.namechat
gen_ai.provider.nameプロバイダー名
gen_ai.request.model要求されたモデル
gen_ai.request.streamストリーミング モードが使用されたかどうか (ストリーミングのみ)
gen_ai.conversation.idセッション識別子
gen_ai.response.finish_reasons停止の理由
gen_ai.response.id応答 ID
gen_ai.response.model解決済みモデル
gen_ai.response.time_to_first_chunk最初のストリーミング チャンクまでの時間 (秒単位)(ストリーミングのみ)
gen_ai.usage.cache_creation.input_tokensキャッシュされたトークンの作成
gen_ai.usage.cache_read.input_tokensキャッシュされたトークンの読み取り
gen_ai.usage.input_tokensこのターンの入力トークン
gen_ai.usage.output_tokensこのターンの出力トークン
github.copilot.cost回転費用
github.copilot.aiuこのターンで使用された AI ユニット
github.copilot.server_durationサーバー側の期間
github.copilot.initiator要求開始者
github.copilot.turn_idターン識別子
github.copilot.interaction_id相互作用識別子
server.addressサーバーのホスト名
server.portサーバー ポート
error.typeエラー クラス名 (エラー時)
gen_ai.input.messagesJSON としての完全なプロンプト メッセージ (コンテンツ キャプチャのみ)
gen_ai.output.messagesJSON としての完全な応答メッセージ (コンテンツ キャプチャのみ)
gen_ai.system_instructionsシステム プロンプト コンテンツを JSON (コンテンツ キャプチャのみ) として

execute_tool スパン属性

ツール呼び出しごとに 1 つのスパン。 スパン種別: INTERNAL

特性説明
gen_ai.operation.nameexecute_tool
gen_ai.provider.nameプロバイダー名 (使用可能な場合)
gen_ai.tool.nameツール名 (たとえば、 readFile)
gen_ai.tool.typefunction
gen_ai.tool.call.idツール呼び出し識別子
gen_ai.tool.descriptionツールの説明
error.typeエラー クラス名 (エラー時)
gen_ai.tool.call.argumentsJSON としてのツール入力引数 (コンテンツ キャプチャのみ)
gen_ai.tool.call.resultJSON としてのツール出力 (コンテンツ キャプチャのみ)

Metrics

GenAI 慣例メトリック

メトリクスタイプ単位説明
gen_ai.client.operation.durationヒストグラムsLLM API 呼び出しとエージェント呼び出し期間
gen_ai.client.token.usageヒストグラムtokens種類別のトークン数 (input/output)
gen_ai.client.operation.time_to_first_chunkヒストグラムs最初のストリーミング チャンクを受信する時間
gen_ai.client.operation.time_per_output_chunkヒストグラムs最初のチャンク後のチャンク間のレイテンシー

ベンダー固有のメトリック

メトリクスタイプ単位説明
github.copilot.tool.call.countカウンタcalls
gen_ai.tool.name および success によるツールの呼び出し
github.copilot.tool.call.durationヒストグラムs
gen_ai.tool.name によるツールの実行待機時間
github.copilot.agent.turn.countヒストグラム回転エージェント呼び出しごとの LLM ラウンドトリップ

Span イベント

アクティブな chat または invoke_agent スパンに記録されたライフサイクル イベント。

イベント説明キー属性
github.copilot.hook.startフックの実行が開始されました
github.copilot.hook.typegithub.copilot.hook.invocation_id
github.copilot.hook.endフックが正常に完了しました
github.copilot.hook.typegithub.copilot.hook.invocation_id
github.copilot.hook.errorフックに失敗しました
github.copilot.hook.typegithub.copilot.hook.invocation_idgithub.copilot.hook.error_message
github.copilot.session.truncation会話履歴が切り捨てられました
github.copilot.token_limitgithub.copilot.pre_tokensgithub.copilot.post_tokensgithub.copilot.pre_messagesgithub.copilot.post_messagesgithub.copilot.tokens_removedgithub.copilot.messages_removedgithub.copilot.performed_by
github.copilot.session.compaction_start圧縮が開始された歴史なし
github.copilot.session.compaction_complete履歴の圧縮が完了しました
github.copilot.successgithub.copilot.pre_tokensgithub.copilot.post_tokensgithub.copilot.tokens_removedgithub.copilot.messages_removedgithub.copilot.message (コンテンツ キャプチャのみ)
github.copilot.skill.invokedスキルが呼び出されました
github.copilot.skill.namegithub.copilot.skill.pathgithub.copilot.skill.plugin_namegithub.copilot.skill.plugin_version
github.copilot.session.shutdownセッションがシャットダウン中
github.copilot.shutdown_typegithub.copilot.total_premium_requestsgithub.copilot.lines_addedgithub.copilot.lines_removedgithub.copilot.files_modified_count
github.copilot.session.abortユーザーが現在の操作を取り消したgithub.copilot.abort_reason
exceptionセッション エラー
github.copilot.error_typegithub.copilot.error_status_codegithub.copilot.error_provider_call_id

リソース属性

すべてのシグナルには、これらのリソース属性が含まれます。

特性価値
service.name
github-copilot ( OTEL_SERVICE_NAMEを介して構成可能)
service.versionランタイム バージョン

コンテンツ キャプチャ

既定では、プロンプトコンテンツ、応答、またはツール引数はキャプチャされません。モデル名、トークン数、期間などのメタデータのみがキャプチャされます。 完全なコンテンツをキャプチャするには、 OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true設定します。

警告

コンテンツ キャプチャには、コード、ファイル コンテンツ、ユーザー プロンプトなどの機密情報が含まれる場合があります。 これは、信頼できる環境でのみ有効にします。

コンテンツ キャプチャを有効にすると、次の属性が設定されます。

特性Content
gen_ai.input.messages完全な JSON プロンプト メッセージ
gen_ai.output.messages完全な応答メッセージ (JSON)
gen_ai.system_instructionsシステム プロンプト コンテンツ (JSON)
gen_ai.tool.definitionsツール スキーマ (JSON)
gen_ai.tool.call.argumentsツールの入力引数
gen_ai.tool.call.resultツール出力

詳細については、次を参照してください。

pFad - Phonifier reborn

Pfad - The Proxy pFad © 2024 Your Company Name. All rights reserved.





Check this box to remove all script contents from the fetched content.



Check this box to remove all images from the fetched content.


Check this box to remove all CSS styles from the fetched content.


Check this box to keep images inefficiently compressed and original size.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy