Skip to main content
@qcobro/ctl es la herramienta de línea de comandos oficial de QCobro. Envuelve el mismo @qcobro/sdk que usarías desde tu propio código, así que cada comando habla con la misma API que la consola de operador y con la misma autenticación por API key de workspace. Instala un binario qcobro con comandos agrupados por recurso (recurso:acción), como portfolios:list o agents:create.

​
Instala la CLI

Instálala globalmente, o invócala sin instalar con npx.

​
Inicia sesión

Antes de usar cualquier comando que hable con la API, vincula un workspace a tu entorno local con workspaces:login. Te pide el endpoint, una API key de workspace (accessKeyId y accessKeySecret, creados desde la página de API Keys de la consola) y el workspace en el que esa key actúa.
La CLI valida las credenciales contra la API antes de guardarlas. Puedes vincular varios workspaces; cada inicio de sesión nuevo pasa a ser el activo.

workspaces:list

Muestra los workspaces vinculados y cuál está activo.

workspaces:use <workspaceAccessKeyId>

Cambia el workspace activo.

workspaces:active

Muestra el workspace activo actual.

workspaces:logout <workspaceAccessKeyId>

Desvincula un workspace de tu entorno local.

​
Carteras

Sincroniza, lista y consulta carteras del workspace activo.
portfolios:sync lee un archivo JSON con un arreglo de filas de cuenta (el mismo formato que acepta client.portfolios.syncAccounts) y aplica uno de los modos de fusión: APPEND_ONLY, UPDATE_EXISTING o REPLACE.

​
Agentes

Crea plantillas de agente, comprueba su comportamiento antes de usarlas, y sincroniza las de voz con el proveedor.
agents:create acepta los campos propios de cada tipo de canal (VOICE_AI, VOICE_PRERECORDED, SMS, EMAIL, WHATSAPP) como flags; ejecuta qcobro agents:create --help para ver el detalle completo por tipo. Para un agente VOICE_AI, EMAIL o WHATSAPP, agents:eval transmite el resultado de cada turno de un guion de prueba y termina con un veredicto general.
Para un agente SMS o VOICE_PRERECORDED (sin conversación que evaluar), agents:preview renderiza el mensaje o guion contra una cuenta de ejemplo.
agents:sync reintenta la sincronización de una plantilla de voz con el proveedor y reporta si quedó sincronizada. Valida configuración, no conversación.
Consulta Evaluar y previsualizar agentes para el formato completo de escenarios y el detalle de cada evento.

​
Configura un cliente MCP

Si usas @qcobro/mcp con Claude Desktop u otro cliente compatible, mcp:configure escribe la entrada del servidor por ti en un solo paso.
Con un workspace activo (tras workspaces:login), el comando reutiliza esas credenciales. Para un entorno sin sesión iniciada, pasa las credenciales explícitamente.
El comando combina la entrada qcobro con el resto de tu configuración existente y conserva cualquier otro servidor MCP que ya tengas. Reinicia el cliente después de ejecutarlo.

​
Siguientes pasos

Visión general del SDK

El cliente TypeScript que @qcobro/ctl envuelve por dentro.

Servidor MCP

Qué configura mcp:configure y qué herramientas expone el servidor.

Gestionar carteras

El detalle de cada operación de carteras, desde el lado del SDK.

Sincronizar cuentas

El formato de fila y los modos de fusión que usa portfolios:sync.