バケットCLI
Bucketサービスとやり取りするためのコマンドラインインターフェース。CLIを使用すると、アプリ、機能、認証を管理し、Bucket機能用のTypeScript型を生成できます。このツールを使用すると、ターミナルから直接機能フラグ設定ワークフローを効率化できます。
使用法
プロジェクトにローカルに CLI をインストールして開始します。
# npm
npm install --save-dev @bucketco/cli
# yarn
yarn add --dev @bucketco/cli次に、プロジェクトのルート ディレクトリからnewコマンドを実行し、CLI を初期化し、機能を作成し、型をすべて一度に生成します。
# npm
npx bucket new
# yarn
yarn bucket new個別のコマンド
newを実行する代わりに、各ステップを個別に呼び出すことができます。
# Initialize Bucket in your project (if not already setup)
npx bucket init
# Create a new feature
npx bucket features create "My Feature"
# Generate TypeScript types for your features
npx bucket features typesRelated MCP server: SeekChat
構成
CLIは、 bucket initを実行すると、プロジェクトディレクトリにbucket.config.jsonファイルを作成します。このファイルには、Bucket 統合に必要なすべての設定が含まれています。
設定ファイルの構造
bucket.config.jsonファイルで使用できる構成オプションの包括的なリストは次のとおりです。
{
"$schema": "https://unpkg.com/@bucketco/cli@latest/schema.json",
"baseUrl": "https://app.bucket.co",
"apiUrl": "https://app.bucket.co/api",
"appId": "ap123456789",
"typesOutput": [
{
"path": "gen/features.d.ts",
"format": "react"
}
]
}オプション | 説明 | デフォルト |
| 構成の自動補完。 | |
| バケット サービスのベース URL。 | |
| バケット サービスの API URL (API 呼び出しの baseUrl をオーバーライドします)。 | |
| バケット アプリケーション ID。 | 必須 |
| TypeScript型が生成されるパス。文字列、または | 「react」形式の「gen/features.ts」 |
個々のコマンドのコマンドライン オプションを使用して、これらの設定を上書きできます。
コマンド
bucket init
プロジェクトで新しいバケット設定を初期化します。これにより、設定内容が含まれたbucket.config.jsonファイルが作成され、オプションで指定されていない必要な情報の入力が求められます。
npx bucket init [--overwrite]オプション:
--overwrite: 既存の設定ファイルが存在する場合は上書きします。--app-id <id>: アプリケーション ID を設定します。--key-format <format>: 機能のキー形式を設定します。
bucket new [featureName]
すぐに使い始めるためのオールインワンコマンド。このコマンドは、 init 、特徴量の作成、型生成を1つのステップにまとめています。Bucketを最も早く使い始めるには、これを使うのが一番です。
npx bucket new "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom] [--out gen/features.ts] [--format react]オプション:
--key: 機能の特定のキー。--app-id: 使用するアプリ ID。--key-format: 機能キーの形式 (カスタム、スネーク、キャメルなど)。--out: TypeScript 型を生成するパス。--format: 生成されるタイプの形式 (react または node)。
各ステップをより細かく制御したい場合は、代わりに個別のコマンド ( init 、 features create 、 features types ) を使用できます。
bucket login
Bucketアカウントにログインしてください。これにより、以降の操作でCLIが認証され、認証情報が安全に保存されます。
npx bucket loginbucket logout
Bucket アカウントからログアウトし、保存されている資格情報を削除します。
npx bucket logoutbucket features
次のサブコマンドを使用して、Bucket 機能を管理します。
bucket features create [featureName]
Bucketアプリで新しい機能を作成します。オプションが指定されていない場合は、コマンドが対話型プロンプトで機能の作成プロセスをガイドします。
npx bucket features create "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom]オプション:
--key: 機能の特定のキー。--app-id: 使用するアプリ ID。--key-format: 機能キーのフォーマット。
bucket features list
現在のアプリのすべての機能を一覧表示します。これにより、利用可能な機能とその現在の設定を視覚的に把握できます。
npx bucket features list [--app-id ap123456789]オプション:
--app-id: 使用するアプリ ID。
bucket features types
機能用のTypeScript型を生成します。これにより、TypeScript/JavaScriptアプリケーションでBucket機能を使用する際の型安全性が確保されます。
npx bucket features types [--app-id ap123456789] [--out gen/features.ts] [--format react]オプション:
--app-id: 使用するアプリ ID。--out: TypeScript 型を生成するパス。--format: 生成されるタイプの形式 (react または node)。
bucket companies
会社を管理するためのコマンド。
bucket companies list
アプリ内のすべての企業をリストします。
npx bucket companies list [--filter <text>] [--app-id ap123456789]オプション:
--filter: 企業名または ID でフィルタリングします。--app-id: 使用するアプリ ID。
このコマンドは、次の列を含むテーブルを出力します。
id: 会社ID。name: 会社名（設定されていない場合は「(unnamed)」と表示されます）。users: 社内のユーザー数。lastSeen: 会社が最後にアクティブになった日付。
bucket companies features access
企業、セグメント、ユーザーに対して、特定の機能へのアクセスを許可または取り消します。機能キーが指定されていない場合は、リストから選択するよう求められます。
npx bucket companies features access [--app-id ap123456789] [featureKey] [--enable|--disable] [--companies <id...>] [--segments <id...>] [--users <id...>]引数:
featureKey: アクセスを許可/取り消す機能のキー (オプション、省略した場合は対話型選択)。
オプション:
--enable: 指定されたターゲットに対して機能を有効にします。--disable: 指定されたターゲットの機能を無効にします。--users: 対象とするユーザーID。複数回指定できます。--companies: 対象とする企業ID。複数回指定できます。--segments: ターゲットとするセグメントID。複数回指定できます。--app-id: 使用するアプリ ID。
少なくとも1つのターゲット（企業、セグメント、またはユーザー）を指定する必要があります。また、 --enableまたは--disableいずれかを指定する必要がありますが、両方を指定することはできません。
例：
# Enable feature for multiple companies and users
npx bucket companies features access my-feature --enable --companies comp_123 --companies comp_456 --users user_789bucket apps
Bucket アプリを管理するためのコマンド。
グローバルオプション
これらのオプションはどのコマンドでも使用できます。
--debug: 詳細出力のデバッグ モードを有効にします。--base-url <url>: Bucket API のベース URL を設定します。--api-url <url>: API URL を直接設定します (ベース URL をオーバーライドします)。--help: コマンドのヘルプ情報を表示します。
AI支援開発
Bucketは、ルールとモデルコンテキストプロトコル（MCP）を通じて、強力なAI支援開発機能を提供します。これらの機能により、AI開発ツールは開発機能をより深く理解し、より正確な支援を提供できるようになります。
バケットルール（推奨）
rulesコマンドは、プロジェクトにAI固有のルールを設定するのに役立ちます。これらのルールにより、AIツールはBucketと機能フラグの使い方、そしてコードベースでそれらをどのように使用すべきかをより適切に理解できるようになります。
npx bucket rules [--format <cursor|copilot>] [--yes]オプション:
--format: ルールを追加する形式:cursor: Cursor IDE 統合のために.cursor/rules/bucket.mdcにルールを追加します。copilot: GitHub Copilot 統合のために.github/copilot-instructions.mdにルールを追加します。
--yes: 確認プロンプトをスキップし、確認せずに既存のファイルを上書きします。
このコマンドは、プロジェクトにルールを追加します。このルールは、AIツールにBucket機能フラグの設定方法と使用方法に関するコンテキストを提供します。Copilot形式の場合、ルールはファイル内の専用セクションに追加されるため、Bucketのルールと並行して他のCopilot指示を管理できます。
モデルコンテキストプロトコル
モデルコンテキストプロトコル（MCP）は、AIモデルを様々なデータソースやツールに接続するための標準化された方法を提供するオープンプロトコルです。Bucketのコンテキストでは、MCPによりコードエディタは機能フラグ、その状態、そしてコードベース内でのそれらの関係性を理解できるようになります。これにより、機能管理ワークフローとAIを活用した開発ツールの間にシームレスな橋渡しが実現します。MCPサーバーはBucketによってホストされているため、簡単に使い始めることができます。
**注: Bucket 。しかし、Bucket CLI の最新バージョンでは、 mcpコマンドは新しいリモート MCP サーバーへの接続に再利用されています。**_
MCPの設定
mcpコマンドは、エディタまたはAIクライアントをBucketのリモートMCPサーバーに接続するための設定に役立ちます。これにより、AIツールは機能フラグを理解し、よりコンテキストに応じた支援を提供できるようになります。
npx bucket mcp [--app-id <id>] [--editor <editor>] [--scope <local|global>]オプション:
--app-id: MCP 接続に使用するアプリ ID。--editor: 設定するエディター/クライアント:cursor:カーソルIDEvscode:ビジュアルスタジオコードclaude：クロードデスクトップwindsurf：ウィンドサーフィン
--scope: プロジェクトの設定をグローバルに構成するか、ローカルに構成するか。
このコマンドでは次の操作をガイドします。
構成するエディター/クライアントを選択します。
接続する Bucket アプリを選択します。
グローバル構成またはプロジェクトローカル構成のどちらを選択するかを決定します。
選択したエディターに適切な設定ファイルを設定します。
注: このセットアップでは、互換性レイヤーとして
発達
# Build the CLI
yarn build
# Run the CLI locally
yarn bucket [command]
# Lint and format code
yarn lint
yarn format要件
Node.js >=18.0.0
ライセンス
MITライセンス Copyright (c) 2025 Bucket ApS