• Español

      • NocoBase CLI

      Descripción

      NocoBase CLI (nb) es el punto de entrada de línea de comandos de NocoBase, utilizado para inicializar, conectar y gestionar aplicaciones de NocoBase en un espacio de trabajo local.

      Admite dos rutas de inicialización comunes:

      • Conectarse a una aplicación de NocoBase existente y guardarla como un env de CLI
      • Instalar una nueva aplicación de NocoBase mediante Docker, npm o Git, y luego guardarla como un env de CLI

      Al crear una nueva aplicación local, nb init también puede instalar o actualizar NocoBase AI coding skills. Si necesitas omitir este paso, puedes usar --skip-skills.

      Uso

      nb [command]

      El comando raíz se utiliza principalmente para mostrar ayuda y distribuir las invocaciones a grupos de comandos o comandos independientes.

      Grupos de comandos (Topics)

      nb --help muestra los siguientes grupos de comandos:

      Grupo de comandosDescripción
      nb apiLlama a las API de NocoBase mediante la CLI.
      nb appGestiona el estado de ejecución de la aplicación: iniciar, detener, reiniciar, registros y actualización.
      nb backupCrea copias de seguridad y las descarga localmente, o restaura un archivo de copia de seguridad local al env de destino.
      nb configGestiona la configuración predeterminada de la CLI.
      nb dbGestiona la base de datos integrada del env seleccionado.
      nb envGestiona los entornos de proyecto de NocoBase, el env actual, el estado, los detalles y los comandos de tiempo de ejecución.
      nb licenseGestiona las licencias comerciales y los plugins con licencia.
      nb pluginGestiona los plugins del env de NocoBase seleccionado.
      nb scaffoldGenera scaffolding para el desarrollo de plugins de NocoBase.
      nb selfComprueba o actualiza la propia NocoBase CLI.
      nb sessionConfigura NB_SESSION_ID para que el env actual quede aislado por shell o por agent runtime.
      nb skillsComprueba o sincroniza las NocoBase AI coding skills del espacio de trabajo actual.
      nb sourceGestiona proyectos de código fuente locales: descarga, desarrollo, compilación y pruebas.

      Comandos

      Comandos independientes actualmente expuestos directamente por el comando raíz:

      ComandoDescripción
      nb initInicializa NocoBase para que el coding agent pueda conectarse y trabajar.

      Ver ayuda

      Ver la ayuda del comando raíz:

      nb --help

      Ver la ayuda de un comando o grupo de comandos:

      nb init --help
nb app --help
nb backup --help
nb config --help
nb api resource --help
nb license --help

      Ejemplos

      Inicialización interactiva:

      nb init

      Inicializar usando un formulario del navegador:

      nb init --ui

      Crear una aplicación Docker de forma no interactiva:

      nb init --env app1 --yes --source docker --version alpha

      Conectarse a una aplicación existente:

      nb env add app1 --api-base-url http://localhost:13000/api
nb env current
nb env status

      Volver a sincronizar el estado del env después de iniciar la aplicación:

      nb app start -e app1
nb env update app1

      Llamar a una API:

      nb api resource list --resource users -e app1

      Ver la configuración predeterminada de la CLI:

      nb config list
nb config get docker.network

      Ver el estado de la licencia comercial:

      nb license status -e app1
nb license plugins list -e app1

      Crear y descargar una copia de seguridad:

      nb backup create -e app1 --output ./backups

      Restaurar una copia de seguridad local:

      nb backup restore -e app1 --file ./backups/backup_20260520_190408_8397.nbdata --yes --force

      Variables de entorno

      Las siguientes variables de entorno afectan el comportamiento de la CLI:

      VariableDescripción
      NB_CLI_ROOTDirectorio raíz donde la CLI guarda la configuración .nocobase y los archivos de la aplicación local. El valor predeterminado es el directorio personal del usuario actual.
      NB_LOCALEIdioma de los mensajes de la CLI e idioma de la interfaz de inicialización local. Admite en-US y zh-CN.
      NB_SESSION_IDID de sesión del shell actual o del agent runtime. Cuando está configurado, nb env use y nb env current quedan aislados por sesión.

      Ejemplo:

      export NB_CLI_ROOT=/your/workspace
export NB_LOCALE=zh-CN

      Archivo de configuración

      Archivo de configuración predeterminado:

      ~/.nocobase/config.json

      Después de establecer NB_CLI_ROOT=/your/workspace, la ruta del archivo de configuración pasa a ser:

      /your/workspace/.nocobase/config.json

      La CLI también es compatible con la lectura de la configuración heredada del project en el directorio de trabajo actual.

      La caché a nivel de sesión del env actual se almacena en:

      .nocobase/sessions/<NB_SESSION_ID>.json

      El último env usado globalmente se guarda en el campo lastEnv de config.json. Cuando no hay NB_SESSION_ID, la CLI recurre a este valor global.

      La caché de comandos de tiempo de ejecución se almacena en:

      .nocobase/versions/<hash>/commands.json

      Este archivo es generado o actualizado por nb env update y se utiliza para almacenar en caché los comandos de tiempo de ejecución sincronizados desde la aplicación de destino.

      Enlaces relacionados