Producto
CLI

Deploy

Desplegar un worker al workspace

Compila y despliega un archivo TypeScript como worker en tu workspace.

Uso

bash
01plazbot workers deploy <archivo>

Argumentos

ArgumentoDescripcion
<archivo>Ruta al archivo .ts del worker.

Opciones

OpcionDescripcion
--name <nombre>Sobreescribe el nombre del worker (por defecto se extrae del define*).
--description <desc>Sobreescribe la descripcion/reference.
--devDespliega en el entorno de desarrollo.

Ejemplo

bash
01# Desplegar un worker
02plazbot workers deploy ./consultar-inventario.ts
03 
04# Desplegar con nombre custom
05plazbot workers deploy ./mi-worker.ts --name "mi-herramienta-custom"
06 
07# Desplegar en entorno de desarrollo
08plazbot workers deploy ./reporte.ts --dev

Que sucede al desplegar

  1. El CLI lee el archivo .ts y analiza el codigo para extraer metadata (nombre, tipo, cron, parametros).
  2. Compila el TypeScript a JavaScript (strip de tipos, conversion de imports).
  3. Hace upsert en la base de datos: si el worker ya existe (mismo nombre), lo actualiza; si no, lo crea.
  4. Si es un webhook, genera automaticamente la URL publica.
  5. Activa el worker con status active.

Archivo TypeScript

El archivo debe importar y exportar una funcion define* del SDK:

typescript
01import { defineTool } from 'plz/workers'
02 
03export default defineTool({
04 name: 'mi-herramienta',
05 reference: 'Descripcion de la herramienta',
06 agents: ['id_agente'],
07 parameters: [
08 { name: 'param1', type: 'string', description: 'Un parametro' }
09 ],
10 
11 async run(payload, plz) {
12 return { success: true }
13 }
14})

Si el worker tiene secrets (usa plz.env.MI_SECRET), asegurate de configurarlos antes con plazbot workers secret set MI_SECRET valor.

¿Quieres probar la API en vivo? Abre el Playground.