Bienvenidos al CLI

Alcance del CLI

Plazbot CLI es la herramienta oficial de línea de comandos para trabajar con la plataforma Plazbot. Permite gestionar todo tu ecosistema de IA sin salir de la terminal.

Qué puedes hacer

• Agentes de IA: crear agentes con un asistente interactivo, plantillas o archivos JSON; chatear con ellos, gestionar su base de conocimiento y configurar Tool Calling.
• Portal: crear el portal web del workspace, asociarle agentes y gestionar sus enlaces.
• WhatsApp: conectar números, enviar mensajes y plantillas, envíos masivos y webhooks.
• Workers: desplegar código propio (tools, syncs, tareas programadas, webhooks) y gestionar sus secretos.
• Studio: crear y diagnosticar agentes conversando en la terminal.
• Sesión: iniciar sesión desde el navegador una vez y cambiar entre tus workspaces. Con --read-only el token solo puede consultar.
• Datos del workspace: contactos, mensajes, etiquetas, oportunidades, tareas, llamadas, plantillas, campañas, automatizaciones, secuencias, reportes, equipo, vistas y webhooks.
• IA y scripting: --json en todos los comandos, plazbot api para llamar a cualquier endpoint de la API, plazbot commands --json y una skill para que Claude Code use el CLI.

Instalación

01npm install -g plazbot-cli

Requiere Node.js 18.17 o superior. Detalle en Instalación.

Inicio rápido

01# 1. Iniciar sesión desde el navegador (sin copiar API key)
02plazbot login
03 
04# 2. Crear un agente con el asistente interactivo
05plazbot agent create
06 
07# 3. Chatear con tu agente
08plazbot agent chat age_AbcDef123
09 
10# 4. Ver todos tus agentes
11plazbot agent list

Para WhatsApp (conectar tu número y enviar tu primer mensaje) ve a la pestaña WhatsApp.

Uso en scripts y CI

El CLI está pensado para usarse también desde scripts, pipelines y otros agentes:

• --json: los comandos que leen, listan o cambian datos aceptan --json. La salida estándar contiene solo JSON (los mensajes y spinners van a stderr), y los errores se escriben en stderr como {"error":{"message","code","hint"}}.
• -y, --yes: omite las confirmaciones de los comandos destructivos (eliminar, desvincular, envíos masivos). Sin terminal interactiva y sin --yes, esos comandos fallan con This action needs confirmation and there is no interactive terminal. en lugar de quedarse esperando. Si respondes que no a una confirmación, el comando imprime Aborted. y termina con código 1.
• Códigos de salida: 0 si todo salió bien y 1 ante cualquier fallo, incluidos los fallos parciales (por ejemplo, un envío masivo con algún número inválido).
• Números de teléfono: siempre con -p, --phone <number>, en cualquier formato internacional (+51912345678, "+51 912 345 678", 0051...).
• Sesión sin navegador: en CI usa las variables PLAZBOT_API_KEY, PLAZBOT_WORKSPACE_ID y PLAZBOT_ZONE, o plazbot init.

01# Crear un agente desde un archivo y capturar su ID
02AGENT_ID=$(plazbot agent create ./agent.json --json | jq -r '.id')
03 
04# Eliminar sin confirmación
05plazbot agent delete "$AGENT_ID" --yes
06 
07# Comprobar la sesión antes de continuar
08plazbot whoami > /dev/null 2>&1 || exit 1

Comandos disponibles

Referencia rápida