CLI de Bucket

Interfaz de línea de comandos para interactuar con los servicios de Bucket. La CLI permite administrar aplicaciones, funciones, autenticación y generar tipos de TypeScript para las funciones de Bucket. Con esta herramienta, puede optimizar el flujo de trabajo de marcado de funciones directamente desde su terminal.

Uso

Comience instalando la CLI localmente en su proyecto:

# npm
npm install --save-dev @bucketco/cli

# yarn
yarn add --dev @bucketco/cli

Luego, ejecute el new comando desde el directorio raíz de su proyecto, inicializando la CLI, creando una función y generando los tipos a la vez:

# npm
npx bucket new

# yarn
yarn bucket new

Comandos individuales

En lugar de ejecutar new , puede llamar a cada paso individualmente.

# 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

Configuración

La CLI crea un archivo bucket.config.json en el directorio del proyecto al ejecutar bucket init . Este archivo contiene toda la configuración necesaria para la integración de Bucket.

Estructura del archivo de configuración

Aquí hay una lista completa de las opciones de configuración disponibles en el archivo 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"
    }
  ]
}

Puede anular estas configuraciones mediante las opciones de la línea de comandos para comandos individuales.

Comandos

bucket init

Inicialice una nueva configuración de Bucket en su proyecto. Esto crea un archivo bucket.config.json con su configuración y solicita la información necesaria que no se proporciona en las opciones.

npx bucket init [--overwrite]

Opciones:

• --overwrite : sobrescribe el archivo de configuración existente si existe.

• --app-id <id> : Establece el ID de la aplicación.

• --key-format <format> : establece el formato de clave para las funciones.

bucket new [featureName]

Comando todo en uno para empezar rápidamente. Este comando combina init , creación de características y generación de tipos en un solo paso. Úsalo para empezar a usar Bucket más rápido.

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

Opciones:

• --key : Clave específica para la función.

• --app-id : ID de la aplicación a utilizar.

• --key-format : Formato para teclas de función (personalizada, serpiente, camello, etc.).

• --out : Ruta para generar tipos TypeScript.

• --format : Formato de los tipos generados (react o node).

Si prefiere tener más control sobre cada paso, puede utilizar los comandos individuales ( init , features create , features types ) en su lugar.

bucket login

Inicie sesión en su cuenta de Bucket. Esto autenticará su CLI para operaciones posteriores y almacenará las credenciales de forma segura.

npx bucket login

bucket logout

Cierre la sesión de su cuenta de Bucket y elimine las credenciales almacenadas.

npx bucket logout

bucket features

Administre las funciones de su Bucket con los siguientes subcomandos.

bucket features create [featureName]

Crea una nueva función en tu aplicación Bucket. El comando te guía a través del proceso de creación de funciones con indicaciones interactivas si no se proporcionan opciones.

npx bucket features create "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom]

Opciones:

• --key : Clave específica para la función.

• --app-id : ID de la aplicación a utilizar.

• --key-format : Formato para teclas de función.

bucket features list

Enumera todas las funciones de la aplicación actual. Esto te ayuda a visualizar las funciones disponibles y sus configuraciones actuales.

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

Opciones:

• --app-id : ID de la aplicación a utilizar.

bucket features types

Genere tipos TypeScript para sus características. Esto garantiza la seguridad de tipos al usar las características de Bucket en sus aplicaciones TypeScript/JavaScript.

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

Opciones:

• --app-id : ID de la aplicación a utilizar.

• --out : Ruta para generar tipos TypeScript.

• --format : Formato de los tipos generados (react o node).

bucket companies

Comandos para la gestión de empresas.

bucket companies list

Enumere todas las empresas en su aplicación.

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

Opciones:

• --filter : Filtrar empresas por nombre o ID.

• --app-id : ID de la aplicación a utilizar.

El comando genera una tabla con las siguientes columnas:

• id : ID de la empresa.

• name : Nombre de la empresa (muestra "(sin nombre)" si no está configurado).

• users : Número de usuarios en la empresa.

• lastSeen : Fecha en la que la empresa estuvo activa por última vez.

bucket companies features access

Otorgue o revoque el acceso a funciones específicas para empresas, segmentos y usuarios. Si no se proporciona ninguna clave de función, se le pedirá que seleccione una de una lista.

npx bucket companies features access [--app-id ap123456789] [featureKey] [--enable|--disable] [--companies <id...>] [--segments <id...>] [--users <id...>]

Argumentos:

• featureKey : Clave de la función a la que se otorgará/revocará el acceso (opcional, selección interactiva si se omite).

Opciones:

• --enable : habilita la función para los objetivos especificados.

• --disable : deshabilita la función para los objetivos especificados.

• --users : ID de usuario objetivo. Se puede especificar varias veces.

• --companies : ID de empresa objetivo. Se pueden especificar varias veces.

• --segments : ID de segmento al que se dirige. Se pueden especificar varias veces.

• --app-id : ID de la aplicación a utilizar.

Se debe especificar al menos un objetivo (empresas, segmentos o usuarios). También debe especificar --enable o --disable , pero no ambos.

Ejemplo:

# 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

Comandos para administrar aplicaciones Bucket.

Opciones globales

Estas opciones se pueden utilizar con cualquier comando:

• --debug : habilita el modo de depuración para salida detallada.

• --base-url <url> : establece la URL base para la API de Bucket.

• --api-url <url> : Establece la URL de la API directamente (anula la URL base).

• --help : Muestra información de ayuda para un comando.

Desarrollo asistido por IA

Bucket ofrece potentes capacidades de desarrollo asistido por IA mediante reglas y el Protocolo de Contexto de Modelo (MCP). Estas funciones ayudan a tus herramientas de desarrollo de IA a comprender mejor tus características y a brindar una asistencia más precisa.

Reglas de los cubos (recomendadas)

El comando rules te ayuda a configurar reglas específicas de IA para tu proyecto. Estas reglas permiten que las herramientas de IA comprendan mejor cómo trabajar con Bucket y los indicadores de características, y cómo deben usarse en tu código base.

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

Opciones:

• --format : Formato para agregar reglas en:

  • cursor : agrega reglas a .cursor/rules/bucket.mdc para la integración de Cursor IDE.

  • copilot : agrega reglas a .github/copilot-instructions.md para la integración de GitHub Copilot.

• --yes : omite las solicitudes de confirmación y sobrescribe los archivos existentes sin preguntar.

Este comando agregará reglas a tu proyecto que proporcionan a las herramientas de IA contexto sobre cómo configurar y usar las características de Bucket. Para el formato de copiloto, las reglas se agregarán a una sección específica del archivo, lo que te permitirá mantener otras instrucciones de copiloto junto con las reglas de Bucket.

Protocolo de contexto modelo

El Protocolo de Contexto de Modelo (MCP) es un protocolo abierto que proporciona una forma estandarizada de conectar modelos de IA a diferentes fuentes de datos y herramientas. En el contexto de Bucket, MCP permite al editor de código comprender los indicadores de características, sus estados y sus relaciones dentro del código base. Esto crea una conexión fluida entre el flujo de trabajo de gestión de características y las herramientas de desarrollo basadas en IA. El servidor MCP está alojado por Bucket, por lo que es muy fácil empezar.

**Nota: El comando CLI de Bucket mcp se usaba anteriormente para un servidor _local . Sin embargo, en versiones recientes de la CLI de Bucket, el comando mcp se ha reutilizado para facilitar la conexión al nuevo servidor MCP remoto.**_

Configuración de MCP

El comando mcp te ayuda a configurar tu editor o cliente de IA para que se conecte con el servidor MCP remoto de Bucket. Esto permite que tus herramientas de IA comprendan tus indicadores de características y te brinden asistencia más contextual.

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

Opciones:

• --app-id : ID de la aplicación que se utilizará para la conexión MCP.

• --editor : El editor/cliente a configurar:

  • cursor : IDE de cursor

  • vscode : Código de Visual Studio

  • claude : Escritorio de Claude

  • windsurf : Windsurf

• --scope : si desea configurar ajustes globales o locales para el proyecto.

El comando le guiará a través de:

1. Seleccionar qué editor/cliente configurar.

2. Elegir a qué aplicación de Bucket conectarse.

3. Decidir entre configuración global o local del proyecto.

4. Configurar el archivo de configuración apropiado para el editor elegido.

Nota: La configuración utiliza mcp-remote como capa de compatibilidad, lo que permite que el servidor MCP de Bucket alojado remotamente funcione con todos los editores/clientes compatibles con servidores MCP STDIO. Si su editor/cliente admite la transmisión HTTP con OAuth, puede conectarse directamente al servidor MCP de Bucket.

Desarrollo

# Build the CLI
yarn build

# Run the CLI locally
yarn bucket [command]

# Lint and format code
yarn lint
yarn format

Requisitos

• Node.js >=18.0.0

Licencia

Licencia MIT Copyright (c) 2025 Bucket ApS