nb api comandos dinámicos

Además de nb api resource, bajo nb api existe un grupo de comandos generados dinámicamente a partir del esquema OpenAPI de la aplicación NocoBase. Estos comandos se generan y se almacenan en caché la primera vez que se ejecuta nb env add o nb env update.

Grupos comunes

Grupo de comandosDescripción
nb api aclGestión de permisos: roles, permisos de recurso y permisos de operación
nb api api-keysGestión de API Keys
nb api appGestión de la aplicación
nb api authenticatorsGestión de autenticación: contraseña, SMS, SSO, etc.
nb api data-modelingModelado de datos: fuentes de datos, tablas y campos
nb api file-managerGestión de archivos: servicios de almacenamiento y archivos adjuntos
nb api flow-surfacesComposición de páginas: páginas, bloques, campos y acciones
nb api system-settingsConfiguración del sistema: título, logo, idioma, etc.
nb api theme-editorGestión de temas: colores, tamaños y conmutación de temas
nb api workflowWorkflow: gestión de procesos automatizados

Los grupos y comandos disponibles realmente dependen de la versión de la aplicación NocoBase conectada y de los plugins habilitados. Ejecute los siguientes comandos para ver los comandos compatibles con la aplicación actual:

nb api --help
nb api <topic> --help

Parámetros del cuerpo de la solicitud

Los comandos dinámicos con cuerpo de solicitud admiten:

ParámetroTipoDescripción
--bodystringCuerpo de la solicitud como cadena JSON
--body-filestringRuta a un archivo JSON

--body y --body-file son mutuamente excluyentes.

Los comandos dinámicos de la API también admiten:

  • --env, -e: nombre de la env de CLI a la que se enviará la solicitud; si se omite, se usa la env actual
  • --yes, -y: cuando un --env pasado explícitamente apunta a una env distinta de la env actual, omite la confirmación interactiva

Si pasa --env explícitamente y es diferente de la env actual, la CLI pedirá confirmación primero. En terminales no interactivos o sesiones de agentes de IA, agregue --yes usted mismo o ejecute antes nb env use <name> y vuelva a intentarlo.

Comandos relacionados