La CLI es una versión preliminar pública (versión 0.x). Los nombres de los comandos siguen la API y todavía pueden cambiar antes de la 1.0. Un comando renombrado sigue funcionando durante al menos una versión menor.
Requisitos
- Node.js 22 o posterior.
- Un plan del espacio de trabajo con API Access, el mismo requisito que la API REST.
- Una clave de API de Settings → API & MCP.
Inicio rápido
1
Instala
2
Inicia sesión
Crea una clave de API en Settings → API & MCP y ejecuta:Pega la clave cuando se te pida. Lo que escribes permanece oculto y la clave se guarda en el llavero de tu sistema.
3
Ejecuta tus primeros comandos
Cómo funcionan los comandos
Cada operación de la referencia de la API es un comando. El nombre del comando es el ID de la operación en kebab case, así que Start an outbound call (createCall) se convierte en famulor create-call.
- Los parámetros de ruta son argumentos:
famulor get-assistant <id>. - Los parámetros de consulta y los campos del cuerpo son opciones en kebab case:
assistant_idse convierte en--assistant-id. - Las opciones tienen tipo y se validan antes de enviar nada: los números deben ser números, las opciones de una lista deben ser uno de los valores permitidos y los campos obligatorios deben estar presentes.
Más información
Inicio de sesión y espacios de trabajo
Almacenamiento en el llavero, claves para CI, un perfil por espacio de trabajo y dominios de marca blanca.
Comandos y salida
Cuerpos de solicitud, subida de archivos, tablas, JSON Lines, paginación y descargas.
Scripts, CI y agentes de código
Automatización segura, códigos de salida, pipelines con
jq y el esquema de comandos para agentes.Referencia
Opciones globales, variables de entorno, códigos de salida y solución de problemas.