From a201313110ebdeb488c81e60fc6260bacf7ba2d5 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 6 Jul 2026 02:02:27 +0000 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20README=20=E3=81=AE=E5=B0=8E?= =?UTF-8?q?=E7=B7=9A=E3=82=92=E6=95=B4=E7=90=86=EF=BC=88=E4=B8=BB=E3=81=AA?= =?UTF-8?q?=E6=8F=90=E4=BE=9B=E7=89=A9=E2=86=92=E3=82=AF=E3=82=A4=E3=83=83?= =?UTF-8?q?=E3=82=AF=E3=82=B9=E3=82=BF=E3=83=BC=E3=83=88=E2=86=92Plugin=20?= =?UTF-8?q?=E3=81=AE=E9=A0=86=E3=81=AB=E5=A4=89=E6=9B=B4=E3=83=BB=E7=B0=A1?= =?UTF-8?q?=E6=BD=94=E5=8C=96=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - クイックスタートを主な提供物の直後に移動し、npm i -g と動作確認だけに絞る - クローン手順・npx tsx フォールバック・npm run alias は開発セクションへ移設 - Plugin 節を「Skill は必要に応じて plugin で追加」の位置づけで簡潔化 （Claude Code の手順を圧縮、Cursor の導入経路 A を intro に統合、 Codex のステップをコードブロックに集約、Antigravity の重複記述を削除） - Troubleshooting / セットアップの参照リンクを移設先に合わせて更新 Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1 --- README.md | 134 +++++++++++++++++++++--------------------------------- 1 file changed, 52 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index 18343af..39f4b5b 100644 --- a/README.md +++ b/README.md @@ -77,69 +77,66 @@ bitbank paper create-order --pair=btc_jpy --side=buy --type=market --amount=0.00 カテゴリは分析系・取引系（paper-trade）・ユーティリティ・Recipe。詳細は [Agent Skills](#agent-skills) を参照。 -## Plugin としてインストールする +## クイックスタート -Plugin が登録するのは **Skills（モデルへの指示書）だけ**で、実処理を担う CLI 本体は含まれません。**どの導線でも `npm i -g bitbank-lab-cli` が別途必須**です（[前提条件](#前提条件) 参照。plugin cache 同梱の `bin/bitbank` は依存を含まず直接実行できません）。 +npm から CLI 本体をグローバルインストールします（Node.js 22 以上 → [前提条件](#前提条件)）。 -Plugin 登録が必要なのは「**リポジトリを開いていない場所でも Skill を使いたい**」場合だけです。Claude Code / Cursor でこのリポジトリを clone して開く使い方なら、Skill は自動で有効になるため登録不要です（[想定する使い方](#想定する使い方) 参照）。 +```bash +npm i -g bitbank-lab-cli -> 注: `/plugin install` はローカル版 Claude Code CLI（ターミナル）用の slash command です。Web 版（[claude.ai/code](https://claude.ai/code)）はコンテナが一時的で `bitbank` CLI を PATH へ永続化できないため動作しません。 +# 動作確認 +bitbank ticker btc_jpy +bitbank candles btc_jpy --type=1day --format=table +``` -### Claude Code +- install なしで試す: `npx -y bitbank-lab-cli ticker btc_jpy` +- アンインストール: `npm uninstall -g bitbank-lab-cli` -slash command は **1 行ずつ送信**してください（一気に貼り付けると 1 つのコマンドとして解釈されて失敗します）。 +以降の README 内コマンド例は `bitbank` が PATH に通っている前提です。skills の改造やコントリビュートにはクローン手順（`./install.sh`）を使います（[開発](#開発) 参照）。 -1. マーケットプレイスを登録: +## Plugin としてインストールする - ``` - /plugin marketplace add bitbankinc/bitbank-lab-cli - ``` +Skill（自然言語操作の指示書）は、必要に応じて plugin で追加します。plugin に含まれるのは **Skills だけ**で、実処理を担う CLI 本体は含まれません。**どの導線でも [クイックスタート](#クイックスタート) の `npm i -g bitbank-lab-cli` が別途必須**です（plugin cache 同梱の `bin/bitbank` は依存を含まず直接実行できません）。 -2. plugin をインストール: +Plugin 登録が必要なのは「**リポジトリを開いていない場所でも Skill を使いたい**」場合だけです。Claude Code / Cursor でこのリポジトリを clone して開くなら、Skill は自動で有効になるため登録不要です（[想定する使い方](#想定する使い方) 参照）。 - ``` - /plugin install bitbank-lab-cli@bitbank-lab-cli - ``` +> 注: `/plugin install` はローカル版 Claude Code CLI（ターミナル）用の slash command です。Web 版（[claude.ai/code](https://claude.ai/code)）はコンテナが一時的なため動作しません。 -3. インストール直後は、今開いている Claude Code に skill がまだ読み込まれていません。`/reload-plugins` を実行するか、Claude Code を再起動してください（次回以降の起動では自動ロードされるため、この操作は初回のみです）。 +### Claude Code -### Cursor +slash command を **1 行ずつ**送信します（一気に貼り付けると失敗します）。 -導入経路は 2 つあります。 +``` +/plugin marketplace add bitbankinc/bitbank-lab-cli +``` -**A. リポジトリを開くだけ（plugin 不要）** — Cursor は `.claude/skills/` を互換で読むため、このリポジトリを clone して開けば Skill がそのまま有効になります（[想定する使い方](#想定する使い方) 参照）。 +``` +/plugin install bitbank-lab-cli@bitbank-lab-cli +``` -**B. Plugin として登録（リポジトリを開いていない場所でも使う）** — Cursor の Plugins（Customize）画面で「Search or Paste Link」に GitHub URL を貼って Import します: +インストール直後は skill が未ロードのため、`/reload-plugins` の実行か Claude Code の再起動で反映してください（初回のみ）。 + +### Cursor + +Plugins（Customize）画面の「Search or Paste Link」に GitHub URL を貼って Import します。`skills/` 配下の Skill 一式が user scope（全プロジェクト共通）で登録されます。 ``` https://github.com/bitbankinc/bitbank-lab-cli ``` -Import すると `.cursor-plugin/plugin.json` が読まれ、`skills/` 配下の Skill 一式が user scope（全プロジェクト共通）で登録されます。 - -> **Claude Code と plugin の状態を共有します**（実機確認ベース）: Cursor は plugin の実体・登録情報を Claude Code と同じ `~/.claude/plugins/` 配下（`cache/` / `installed_plugins.json` 等）で管理します。そのため **Claude Code 側で `/plugin install` 済みだと、Cursor では追加操作なしで有効になっている**ことがあります（Plugins 一覧に `Imported` と表示）。 -> -> **更新は自動ではありません**: plugin はバージョン固定キャッシュ（git commit 固定）で保存されるため、リポジトリ側が更新されても自動では追従しません。新しい Skill を取り込むには Plugins 画面から update または再 import してください。 +- plugin の実体は Claude Code と同じ `~/.claude/plugins/` 配下で共有されます。Claude Code 側で `/plugin install` 済みなら、追加操作なしで有効になっていることがあります（一覧に `Imported` と表示） +- plugin は git commit 固定でキャッシュされ、自動更新されません。新しい Skill を取り込むには Plugins 画面から update または再 import してください ### Codex CLI -導入は「marketplace 追加 → plugin 名の確認 → add」の 3 ステップです（`codex plugin install /` というサブコマンドは存在しません）。 - ```bash -# 1. marketplace を追加 codex plugin marketplace add bitbankinc/bitbank-lab-cli - -# 2. 登録された plugin 名を確認する（重要） -codex plugin list - -# 3. list に表示された @ をそのまま指定して add -codex plugin add @ +codex plugin list # 登録された plugin 名を確認 +codex plugin add @ # list の表示名をそのまま指定 ``` -- `@` の名前は決め打ちせず、**`codex plugin list` に表示されたものをそのまま使ってください**（環境や manifest により変わります）。 -- 実行中、Codex が `~/.codex` 配下への書き込みの承認プロンプトを出すことがあります。**Yes** で進めてください。 -- **macOS**: 内部で `git clone` を実行するため Xcode Command Line Tools が必要です（[前提条件](#前提条件) 参照）。 -- CLI 本体（`npm i -g bitbank-lab-cli`）は別途必要です（[前提条件](#前提条件) 参照）。 +- `@` は決め打ちせず、**`codex plugin list` の表示をそのまま使ってください**（`codex plugin install /` というサブコマンドはありません） +- 実行中に `~/.codex` への書き込み承認を求められたら **Yes** で進めます。macOS は Xcode Command Line Tools が必要です（[前提条件](#前提条件) 参照） ### Antigravity CLI（旧 Gemini CLI） @@ -147,9 +144,7 @@ codex plugin add @ agy plugin install https://github.com/bitbankinc/bitbank-lab-cli ``` -Plugin install で skills が登録され、`bitbank` CLI（`npm i -g bitbank-lab-cli` で別途インストール）と組み合わせて使えます。自動 install したくない場合は [Codex CLI / Antigravity CLI で使う](#codex-cli--antigravity-cli-で使う) の手動コピー手順も使えます。 - -> 旧 Gemini CLI は 2026-06-18 に個人向け提供が終了し、Antigravity CLI（`agy`）へ移行しました（旧環境からは `agy plugin import gemini` で移行可能）。本リポジトリは `plugin.json` と旧 `gemini-extension.json` を両置きしており、新旧どちらの CLI からも install できます。 +旧 Gemini CLI 環境からは `agy plugin import gemini` で移行できます（本リポジトリは新旧両方の manifest を同梱）。自動 install したくない場合は [Codex CLI / Antigravity CLI で使う](#codex-cli--antigravity-cli-で使う) の手動コピー手順も使えます。 > 注: 各エージェントの plugin install コマンドは仕様変更が多いため、動かない場合は公式ドキュメントを確認してください。 @@ -163,50 +158,11 @@ Plugin install で skills が登録され、`bitbank` CLI（`npm i -g bitbank-la Skills は利用者が自由に追加・編集していく前提なので、リポジトリごと手元に置きます。 -## クイックスタート - -npm から `bitbank` コマンドをグローバルインストールするのがいちばん簡単です。環境要件は [前提条件](#前提条件) を参照（Node.js 22 以上）。 - -```bash -npm i -g bitbank-lab-cli - -# 動作確認 -bitbank ticker btc_jpy -bitbank candles btc_jpy --type=1day --format=table -``` - -試し叩きだけなら `npx -y bitbank-lab-cli ticker btc_jpy` で install なしに実行できます。アンインストールは `npm uninstall -g bitbank-lab-cli`。 - -skills を改造したい場合や開発に参加したい場合は、リポジトリをクローンして `./install.sh` を叩く手順も使えます（内部で `npm ci` と `npm link` を実行）。 - -```bash -git clone https://github.com/bitbankinc/bitbank-lab-cli.git -cd bitbank-lab-cli -./install.sh -``` - -`install.sh` を使わず手元で都度実行する場合は、以下のフォールバック手順でも同じことができます。**以降の README 内コマンド例はすべて `bitbank` コマンドが PATH に通っている前提で記載しています**。フォールバック環境では `bitbank` を `npx tsx cli/index.ts` に、Private API は `npx tsx --env-file=.env cli/index.ts` に読み替えてください。 - -```bash -npm ci -npx tsx cli/index.ts ticker btc_jpy -# Private API（.env を tsx に直接読ませる） -npx tsx --env-file=.env cli/index.ts assets -``` - -毎回 `npx tsx ...` を打つのが手間なら、`npm run` の短縮 alias も使えます（`--` 以降が CLI 引数）。 - -```bash -npm run cli -- ticker btc_jpy -# Private API（.env を読み込む版） -npm run cli:env -- assets -``` - ## セットアップ ### 1. インストール -[クイックスタート](#クイックスタート) を参照（CLI を使うだけなら `npm i -g bitbank-lab-cli`、skills を改造する場合はクローンして `./install.sh`）。 +[クイックスタート](#クイックスタート) を参照（CLI を使うだけなら `npm i -g bitbank-lab-cli`、skills を改造する場合は [開発](#開発) のクローン手順）。 ### 2. API キーを設定する（Private API / Trade 用） @@ -434,8 +390,8 @@ private / trade の 403 は本物の権限失敗として `AUTH`(2) のまま。 CLI がグローバルインストールされていない、または `npm i -g` 後に PATH へ 反映されていない可能性。`npm i -g bitbank-lab-cli` でインストールするか、 -クローン済み環境では [クイックスタート](#クイックスタート) のフォールバック -手順（`npx tsx cli/index.ts ...`）で代替できます。 +クローン済み環境では [開発](#開発) のフォールバック手順 +（`npx tsx cli/index.ts ...`）で代替できます。 ### `BITBANK API credentials are not configured` 系のエラー @@ -751,6 +707,20 @@ APIキーおよび取引に必要なパスワード等は利用者自身の責 ## 開発 +### クローンして実行する + +skills の改造やコントリビュートは、クローンして `./install.sh` を実行するのが基本です（内部で `npm ci` と `npm link` を実行し、`bitbank` コマンドが PATH に入ります）。 + +```bash +git clone https://github.com/bitbankinc/bitbank-lab-cli.git +cd bitbank-lab-cli +./install.sh +``` + +`npm link` せずに都度実行したい場合は、`bitbank` を `npx tsx cli/index.ts` に読み替えます（Private API は `npx tsx --env-file=.env cli/index.ts`）。短縮 alias として `npm run cli -- ` / `npm run cli:env -- ` も使えます（`--` 以降が CLI 引数）。 + +### テスト・lint + ```bash npm test # テスト実行（E2E はスキップ） npm run test:watch # ウォッチモード（変更を監視して再実行） From 25ea1b5c1ac80adac58d7377ffc5326815b0576c Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 6 Jul 2026 02:11:15 +0000 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20README=20=E3=81=AE=20fenced=20code?= =?UTF-8?q?=20block=20=E3=81=AB=E8=A8=80=E8=AA=9E=E6=8C=87=E5=AE=9A?= =?UTF-8?q?=E3=82=92=E8=BF=BD=E5=8A=A0=EF=BC=88MD040=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_017jXQpU8ovE1LgRgRFS6JV1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 39f4b5b..22fb766 100644 --- a/README.md +++ b/README.md @@ -106,11 +106,11 @@ Plugin 登録が必要なのは「**リポジトリを開いていない場所 slash command を **1 行ずつ**送信します（一気に貼り付けると失敗します）。 -``` +```text /plugin marketplace add bitbankinc/bitbank-lab-cli ``` -``` +```text /plugin install bitbank-lab-cli@bitbank-lab-cli ``` @@ -120,7 +120,7 @@ slash command を **1 行ずつ**送信します（一気に貼り付けると Plugins（Customize）画面の「Search or Paste Link」に GitHub URL を貼って Import します。`skills/` 配下の Skill 一式が user scope（全プロジェクト共通）で登録されます。 -``` +```text https://github.com/bitbankinc/bitbank-lab-cli ```