Skip to main content
Version: v1.1.1

⚙️ Documentation for the config Command – Cuemby CLI

The config command allows you to manage your CLI configuration, including setting an API key, organization, context, or viewing current configuration.

🔧 General Usage​

cpctl config <subcommand> [flags]
  • <subcommand>: One of auth, view, set-context
  • --name, -n: Organization name (optional override)
  • --server, -s: Server URL (optional override)

📦 Supported Subcommands​

auth​

cpctl config auth <apiKey> [--name <org>] [--server <url>]

Description: Sets an API key for authenticating the organization in the CLI.

  • Requires: apiKey as argument
  • Optional flags:
    • --name, -n: Custom name for the organization
    • --server, -s: Server URL (default: Cuemby platform host)

view​

cpctl config view

Description: Displays the current CLI configuration in YAML format.
Output: Entire configuration block.

set-context​

cpctl config set-context <name>

Description: Sets the current active configuration context by name.

  • Requires: name argument (context name)

⚠️ Validation & Notes​

  • If no server is passed in auth, it defaults to empty or platform default.
  • If no org name is passed, it defaults to "default" (this will be replaced with a value returned from a future validation step).

🛠️ Command Registration and Flags​

rootCmd.AddCommand(configCmd)

configCmd.AddCommand(configAuthCmd)
configCmd.AddCommand(configViewCmd)
configCmd.AddCommand(configSetContextCmd)

configAuthCmd.Flags().StringVarP(&shared.CurrentConfig.Overwrite.Organization, "name", "n", "", "Organization name (for overwrite or set custom name)")
configAuthCmd.Flags().StringVarP(&shared.CurrentConfig.Overwrite.Server, "server", "s", "", "server url (for overwrite. Default is cuemby platform host)")

📚 Dependencies​

  • github.com/spf13/cobra
  • github.com/cuemby/cli/internal/config
  • github.com/cuemby/cli/internal/shared
  • encoding/base64: for decoding configuration data

✅ Example​

cpctl config auth sk_live_abc123 -n acme --server https://api.cuemby.dev
cpctl config view
cpctl config set-context default

⚙️ Documentación del Comando config – Cuemby CLI

El comando config permite gestionar la configuración del CLI, incluyendo la autenticación con API Key, selección de organización, cambio de contexto o visualización de configuración actual.

🔧 Uso General​

cpctl config <subcomando> [flags]
  • <subcomando>: Puede ser auth, view, set-context
  • --name, -n: Nombre de la organización (opcional)
  • --server, -s: URL del servidor (opcional)

📦 Subcomandos Soportados​

auth​

cpctl config auth <apiKey> [--name <org>] [--server <url>]

Descripción: Establece una API Key para autenticar la organización desde el CLI.

  • Requiere: argumento apiKey
  • Flags opcionales:
    • --name, -n: Nombre personalizado de la organización
    • --server, -s: URL del servidor (por defecto: host de Cuemby)

view​

cpctl config view

Descripción: Muestra la configuración actual en formato YAML.
Salida: Bloque completo de configuración.

set-context​

cpctl config set-context <name>

Descripción: Establece el contexto activo actual por nombre.

  • Requiere: argumento name (nombre del contexto)

⚠️ Validaciones y Notas​

  • Si no se pasa server en auth, se usará el valor por defecto.
  • Si no se pasa org, se usará "default" (esto será reemplazado con la respuesta de un endpoint de validación futuro).

🛠️ Registro y Flags​

rootCmd.AddCommand(configCmd)

configCmd.AddCommand(configAuthCmd)
configCmd.AddCommand(configViewCmd)
configCmd.AddCommand(configSetContextCmd)

configAuthCmd.Flags().StringVarP(&shared.CurrentConfig.Overwrite.Organization, "name", "n", "", "Organization name (for overwrite or set custom name)")
configAuthCmd.Flags().StringVarP(&shared.CurrentConfig.Overwrite.Server, "server", "s", "", "server url (for overwrite. Default is cuemby platform host)")

📚 Dependencias​

  • github.com/spf13/cobra
  • github.com/cuemby/cli/internal/config
  • github.com/cuemby/cli/internal/shared
  • encoding/base64: para decodificar valores de configuración

✅ Ejemplo​

cpctl config auth sk_live_abc123 -n acme --server https://api.cuemby.dev
cpctl config view
cpctl config set-context default