CLI-интерфейс ведра

Интерфейс командной строки для взаимодействия со службами Bucket. CLI позволяет управлять приложениями, функциями, аутентификацией и генерировать типы TypeScript для функций Bucket. С помощью этого инструмента вы можете оптимизировать рабочий процесс пометки функций прямо из терминала.

Использование

Начните с локальной установки 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 types

Related MCP server: decisionnode/DecisionNode

Конфигурация

CLI создает файл bucket.config.json в каталоге вашего проекта при запуске bucket init . Этот файл содержит все необходимые настройки для интеграции 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"
    }
  ]
}

Вы можете переопределить эти настройки, используя параметры командной строки для отдельных команд.

Команды

bucket init

Инициализируйте новую конфигурацию Bucket в вашем проекте. Это создаст файл bucket.config.json с вашими настройками и запросит любую необходимую информацию, не предоставленную через параметры.

npx bucket init [--overwrite]

Параметры:

• --overwrite : Перезаписать существующий файл конфигурации, если он существует.

• --app-id <id> : Установить идентификатор приложения.

• --key-format <format> : Установить формат ключа для функций.

bucket new [featureName]

Команда «все в одном» для быстрого начала работы. Эта команда объединяет init , создание функций и генерацию типов в одном шаге. Используйте ее для самого быстрого способа начать работу с Bucket.

npx bucket new "My Feature" [--app-id ap123456789] [--key my-feature]  [--key-format custom] [--out gen/features.ts] [--format react]

Параметры:

• --key : Конкретный ключ для функции.

• --app-id : Идентификатор приложения для использования.

• --key-format : Формат для функциональных клавиш (пользовательский, змея, верблюд и т. д.).

• --out : Путь для генерации типов TypeScript.

• --format : Формат сгенерированных типов (react или node).

Если вы предпочитаете больший контроль над каждым шагом, вы можете использовать отдельные команды ( init , features create , features types ).

bucket login

Войдите в свою учетную запись Bucket. Это позволит аутентифицировать ваш CLI для последующих операций и безопасно сохранить учетные данные.

npx bucket login

bucket logout

Выйдите из своей учетной записи Bucket, удалив сохраненные учетные данные.

npx bucket logout

bucket 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 : Идентификатор приложения для использования.

• --key-format : Формат для функциональных клавиш.

bucket features list

Перечислите все функции текущего приложения. Это поможет вам визуализировать доступные функции и их текущие конфигурации.

npx bucket features list [--app-id ap123456789]

Параметры:

• --app-id : Идентификатор приложения для использования.

bucket features types

Генерируйте типы TypeScript для своих функций. Это обеспечивает безопасность типов при использовании функций Bucket в ваших приложениях TypeScript/JavaScript.

npx bucket features types [--app-id ap123456789] [--out gen/features.ts] [--format react]

Параметры:

• --app-id : Идентификатор приложения для использования.

• --out : Путь для генерации типов TypeScript.

• --format : Формат сгенерированных типов (react или node).

bucket companies

Команды для управления компаниями.

bucket companies list

Перечислите все компании в вашем приложении.

npx bucket companies list [--filter <text>] [--app-id ap123456789]

Параметры:

• --filter : Фильтрация компаний по названию или идентификатору.

• --app-id : Идентификатор приложения для использования.

Команда выводит таблицу со следующими столбцами:

• id : идентификатор компании.

• name : Название компании (если не указано, отображается «(без названия)»).

• 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 : Идентификаторы пользователей для цели. Можно указать несколько раз.

• --companies : ID компаний для нацеливания. Можно указать несколько раз.

• --segments : Идентификаторы сегментов для нацеливания. Можно указывать несколько раз.

• --app-id : Идентификатор приложения для использования.

Необходимо указать хотя бы одну цель (компании, сегменты или пользователи). Также необходимо указать либо --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_789

bucket apps

Команды для управления приложениями Bucket.

Глобальные возможности

Эти параметры можно использовать с любой командой:

• --debug : включить режим отладки для подробного вывода.

• --base-url <url> : Установить базовый URL для API Bucket.

• --api-url <url> : задать URL-адрес API напрямую (переопределяет базовый URL-адрес).

• --help : Отображение справочной информации по команде.

Разработка с использованием ИИ

Bucket предоставляет мощные возможности разработки с помощью ИИ через правила и протокол контекста модели (MCP). Эти функции помогают вашим инструментам разработки ИИ лучше понимать ваши функции и предоставлять более точную помощь.

Правила корзины (рекомендуется)

Команда rules помогает вам настроить специфические правила AI для вашего проекта. Эти правила позволяют инструментам AI лучше понимать, как работать с флагами Bucket и feature и как их следует использовать в вашей кодовой базе.

npx bucket rules [--format <cursor|copilot>] [--yes]

Параметры:

• --format : Формат для добавления правил:

  • cursor : добавляет правила в .cursor/rules/bucket.mdc для интеграции Cursor IDE.

  • copilot : добавляет правила в .github/copilot-instructions.md для интеграции GitHub Copilot.

• --yes : Пропустить запросы на подтверждение и перезаписать существующие файлы без запроса.

Эта команда добавит правила в ваш проект, которые предоставляют инструментам ИИ контекст о том, как настраивать и использовать флаги функций Bucket. Для формата copilot правила будут добавлены в специальный раздел в файле, что позволит вам поддерживать другие инструкции copilot наряду с правилами Bucket.

Модель контекстного протокола

Model Context Protocol (MCP) — это открытый протокол, который обеспечивает стандартизированный способ подключения моделей ИИ к различным источникам данных и инструментам. В контексте Bucket MCP позволяет вашему редактору кода понимать ваши флаги функций, их состояния и их связи в вашей кодовой базе. Это создает бесшовный мост между вашим рабочим процессом управления функциями и инструментами разработки на основе ИИ. Сервер MCP размещен на Bucket, поэтому начать работу очень просто.

**Примечание: команда Bucket mcp CLI ранее использовалась для локального сервера. Однако в последних версиях Bucket CLI команда mcp была перепрофилирована, чтобы помочь вам подключиться к новому удаленному серверу MCP.**_

Настройка МКП

Команда mcp помогает вам настроить редактор или клиент AI для подключения к удаленному серверу MCP Bucket. Это позволяет вашим инструментам AI понимать ваши флаги функций и предоставлять более контекстную помощь.

npx bucket mcp [--app-id <id>] [--editor <editor>] [--scope <local|global>]

Параметры:

• --app-id : идентификатор приложения, используемый для подключения MCP.

• --editor : Редактор/клиент для настройки:

  • cursor : Курсор IDE

  • vscode : Код Visual Studio

  • claude : Рабочий стол Клода

  • windsurf : виндсерфинг

• --scope : следует ли настраивать параметры глобально или локально для проекта.

Команда проведет вас через:

1. Выбор редактора/клиента для настройки.

2. Выбор приложения Bucket для подключения.

3. Выбор между глобальной или локальной конфигурацией проекта.

4. Настройка соответствующего файла конфигурации для выбранного вами редактора.

Примечание: настройка использует mcp-remote в качестве уровня совместимости, что позволяет удаленному размещенному серверу Bucket MCP работать со всеми редакторами/клиентами, которые поддерживают серверы MCP STDIO. Если ваш редактор/клиент поддерживает HTTP Streaming с OAuth, вы можете подключиться к серверу Bucket MCP напрямую.

Разработка

# 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 Авторские права (c) 2025 Bucket ApS