weekly-sales-report
毎週の売上データ(sales.csv)から、部長に出す週報 weekly_report.md を作るプラグイン
weekly-sales-report は、GitHub Copilot CLI のプラグインです。作業の設定・開始・監視・結果の確認は、ブラウザーの画面(Web管理画面)で行います。作業は、統括・作業・検証の3種類のエージェントが、計画 → 実行 → 評価 を繰り返して進めます。
使うために要る準備
次の3つを、最初に1回行います。
1. インストールする
weekly-sales-report は、マーケットプレイス plugin-market-place に入っています。マーケットプレイスを登録してから、プラグインを入れます。
copilot plugin marketplace add xclang-brain/plugin-market-place
copilot plugin install weekly-sales-report@plugin-market-place
- Copilot CLI の中では、
/plugin marketplace add xclang-brain/plugin-market-placeと/plugin install weekly-sales-report@plugin-market-placeでも入れられます。 - フォルダを直接指定する入れ方(
copilot plugin install ./フォルダ)は、Copilot CLI 1.0.102 が「廃止予定」と表示するので、マーケットプレイスを通す入れ方にしています。
2. 試験的機能を有効にする
画面を動かす仕組み(エクステンション。Copilot CLI が起動する別のプログラム)は、試験的な機能です(Copilot CLI 1.0.102 の時点)。有効にしないと、weekly-sales-report は使えません。試験的な機能なので、Copilot CLI の更新で使い方が変わることがあります。
初めて使うときは、--experimental を付けて Copilot CLI を起動します。一度付けると設定に残るので、次からは付けなくても有効です。
copilot --experimental
すでに起動しているときは、チャットで次のように打ちます。Copilot CLI が自動で再起動して、有効になります。再起動すると、今の会話は終わります。再起動の後は、まだ信頼していないフォルダでは、フォルダを信頼するかの確認が出て、続けて次の「3. 読み込むときの確認を許可する」の確認が出ます(読み込みの確認は、続けて2回出ることがあります)。
/settings experimental on
3. 読み込むときの確認を許可する
weekly-sales-report を読み込むとき、Copilot CLI がチャットに確認を出します。題は Extension "plugin:weekly-sales-report:weekly-sales-report" wants elevated permissions で、本文は次のとおりです。
This extension wants to: skip tool permission prompts, register hooks, handle permission requests.
Denying will prevent this extension from loading.
Copilot CLI 1.0.101 から、この確認は必ずあなたに出ます。許可を自動で判定する設定(Assisted の許可)を使っていても、自動では許可されません。
確認の意味は次のとおりです。
skip tool permission prompts(ツールの許可の確認を省く):weekly-sales-report の記録のツールは、確認なしで動きます。画面に出す状態を書くだけで、ファイルやコマンドなど外を変えません。register hooks(フックを登録する):止めた実行のエージェントのツールと、統括エージェントに許していないツール(ファイルの書き込みやコマンドなど。統括は、それらを作業エージェントに頼みます)を拒むために、Copilot CLI の「ツールを使ってよいか」の問い合わせを受けます。handle permission requests(許可の求めを扱う):エージェントの許可の求めを見て、画面に「チャットで確認を待っています」と示します。weekly-sales-report は許可の求めに答えません。許可も拒否も、あなたがチャットで行います。
許可する理由は、断ると読み込まれず、画面で開始も監視もできないからです。選び方は次のとおりです。
| 選択肢 | 意味 |
|---|---|
| Yes | 今回だけ許可します。Copilot CLI を起動するたびと、/clear のたびに、また確認が出ます |
Yes, and always allow "plugin:weekly-sales-report:weekly-sales-report" in this directory(後ろにフォルダの場所が付きます。作業フォルダが Git のリポジトリのときは、in this directory の代わりに in this repo と出ます) | このフォルダでは常に許可します。このフォルダでは、次から確認が出ません(/clear の後も、起動し直しても)。ほかのフォルダでは、また出ます |
| Yes, and don't ask again for "plugin:weekly-sales-report:weekly-sales-report" this session | フォルダが分からないときに、上の選択肢の代わりに出ます。このセッション(Copilot CLI の1つの会話。/clear で新しいセッションになります)の間は、確認が出ません |
| No (Esc) | 断ります。weekly-sales-report は読み込まれません |
初めて使うときと、/settings experimental on で再起動した後は、フォルダを信頼するかの確認の後に、この確認が続けて2回出ることがあります。
使い方
- Copilot CLI を起動し、チャットで作業を頼みます。
- チャットに、Web管理画面の URL が示されます。URL には合言葉が入っています。ブラウザーで開きます。この URL は、weekly-sales-report を動かしているマシンのブラウザーからだけ開けます。
- 画面で、役割(統括・作業・検証)ごとに使うモデル、繰り返しの上限の回数、この作業だけの設定を決めて、開始ボタンを押します。Copilot CLI のモデルが Auto のときは、役割ごとのモデルが効かないことがあります。そのことと、実際に動いたモデルが画面に示されます。
- 実行中は、画面で、各エージェントの状態と担当、今が計画・実行・評価のどれか、エージェント間のデータの受け渡しを見られます。止めるときは、止めるボタンを押します。
- 終わったら、画面で、各エージェントの実行結果、検証結果、まとめ、終わった理由、課題の一覧を見られます。
実行中に気をつけること
- 実行中は
/clearを使わないでください。/clearをすると、画面の更新が止まり、前の画面の URL では開けなくなります。そのときは、チャットでもう一度作業を頼み、示された画面を開くと、前の実行が途中で切れたことが示されます。 - 実行中の確認には、チャットで答えます。ファイルの書き込みやコマンドの実行の許可、AI クレジットの上限の確認、エージェントからの質問が、チャットに出ます。画面には、チャットで確認を待っていることと、何の確認かが示されます。画面からは答えられません。
- 止めた後、チャットに確認が残っていることがあります。その確認には、「Yes」と答えても「No」と答えても、ツールは動きません。
- 止めきれなかったエージェントがいるときは、画面にそのエージェントと止め方(チャットで Esc を2回押す、または Copilot CLI を終える)が示されます。
任せたいツールを前もって許可する
確認のたびにチャットに戻る手間を減らすには、Copilot CLI を起動するときに、任せたいツールを --allow-tool で指定します。指定は、その起動の間だけ有効です。
| 指定 | 許可するもの |
|---|---|
copilot --allow-tool=write | ファイルの書き込み |
copilot --allow-tool='shell(git:*)' | git のコマンド |
copilot --allow-tool='read, write' | ファイルの読み取りと書き込み(複数は、引用符で囲んで、カンマで区切ります) |
copilot --allow-tool='shell(git:*)' --deny-tool='shell(git push)' | git push 以外の git のコマンド |
すべてを任せる指定(--allow-all-tools、--allow-all、--yolo)もあります。公式のドキュメントは、隔離した環境でだけ使うよう強く勧めています。
課題の一覧と Issue の起票
終わった後の画面に、課題の一覧と、weekly-sales-report 自身を改善するための Issue の案が並びます。案ごとの承認ボタンを押すと、その案が weekly-sales-report 自身の GitHub リポジトリに Issue として起票されます。承認していない案は起票されません。
起票できるようにするには、次の手順を行います。起票できないときも案は並び、この手順が画面に示されます。
-
weekly-sales-report を GitHub に公開します。
-
plugin.jsonのrepositoryに、そのリポジトリの URL(例:https://github.com/OWNER/REPO)を書きます。手元のフォルダのマーケットプレイスから入れたときは、Copilot CLI を起動し直すか、/clearで新しい会話を始めると反映されます。GitHub から入れたときは、直したplugin.jsonを GitHub に送ってから、weekly-sales-report を入れ直します。copilot plugin uninstall weekly-sales-report copilot plugin install weekly-sales-report@plugin-market-place -
gh(GitHub の公式のコマンド)を入れて、ログインします。gh auth login
試験
構造の検査と部品の試験は、リポジトリの1つのコマンドで動かせます。モデルを使わないので、AI クレジットを使いません。plugin-creator を入れていなくても動きます。
python3 tests/run.py
- 最初に、試験に要る道具がそろっているかを確かめ、足りなければ足りない道具を示して止まります。
- 段階ごとの合否と、不合格の試験とその理由が出ます。同じ内容がファイルにも書かれ、終了コードでも合否が分かります。
- weekly-sales-report を直した後も、同じコマンドで試験をやり直せます。
EVAL(実際のモデルで課題を実行して採点する試験)は、plugin-creator を入れた Copilot CLI で、weekly-sales-report の試験を頼むと行われます。tests/eval/ の課題と合否の基準を使います。AI クレジットを使うので、始める前に、実行の回数と使う AI クレジットの見込みが示されます。よいと答えてから始まります。
うまく始まらないとき
チャットで作業を頼んでも画面の URL が示されないときは、weekly-sales-report のエクステンションが読み込まれていません。次のどれかです。
- 試験的機能を有効にしていない:
copilot --experimentalで起動し直します。すでに起動しているときは、チャットで/settings experimental onと打ちます(自動で再起動します)。 - 読み込むときの確認を断った:Copilot CLI を起動し直して、出た確認を許可します。選び方は「3. 読み込むときの確認を許可する」にあります。
- エクステンションを使わない設定(
/extensions modeの Disabled)にしている:/extensions modeで Load & Augment か Load Only に戻します。Disabled は、次に Copilot CLI を起動したときにも残ります。