• Français

      • NocoBase CLI

      Description

      NocoBase CLI (nb) est le point d’entrée en ligne de commande de NocoBase, utilisé pour initialiser, connecter et gérer les applications NocoBase dans l’espace de travail local.

      Il prend en charge deux parcours d’initialisation courants :

      • Se connecter à une application NocoBase existante et l’enregistrer comme environnement CLI
      • Installer une nouvelle application NocoBase via Docker, npm ou Git, puis l’enregistrer comme environnement CLI

      Lors de la création d’une nouvelle application locale, nb init peut également installer ou mettre à jour les skills de codage IA de NocoBase. Si vous devez ignorer cette étape, vous pouvez utiliser --skip-skills.

      Utilisation

      nb [command]

      La commande racine sert principalement à afficher l’aide et à répartir les appels vers des groupes de commandes ou des commandes autonomes.

      Groupes de commandes (Topics)

      nb --help affiche les groupes de commandes suivants :

      Groupe de commandesDescription
      nb apiAppeler l’API NocoBase via le CLI.
      nb appGérer l’état d’exécution de l’application : démarrer, arrêter, redémarrer, journaux et mise à niveau.
      nb backupCréer une sauvegarde et la télécharger en local, ou restaurer un fichier de sauvegarde local vers l’environnement cible.
      nb configGérer la configuration par défaut du CLI.
      nb dbGérer la base de données intégrée de l’environnement sélectionné.
      nb envGérer les environnements de projet NocoBase, l’environnement courant, l’état, les détails et les commandes d’exécution.
      nb licenseGérer la licence commerciale et les plugins sous licence.
      nb pluginGérer les plugins de l’environnement NocoBase sélectionné.
      nb scaffoldGénérer le scaffold de développement de plugins NocoBase.
      nb selfVérifier ou mettre à jour NocoBase CLI lui-même.
      nb sessionConfigurer NB_SESSION_ID pour isoler l’environnement courant selon le shell ou l’environnement d’exécution de l’agent.
      nb skillsVérifier ou synchroniser les skills de codage IA NocoBase de l’espace de travail actuel.
      nb sourceGérer le projet de code source local : téléchargement, développement, build et tests.

      Commandes (Commands)

      Commandes autonomes actuellement exposées directement par la commande racine :

      CommandeDescription
      nb initInitialiser NocoBase afin que l’agent de codage puisse se connecter et fonctionner.

      Afficher l’aide

      Afficher l’aide de la commande racine :

      nb --help

      Afficher l’aide d’une commande ou d’un groupe de commandes :

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

      Exemples

      Initialisation interactive :

      nb init

      Initialisation à l’aide d’un formulaire dans le navigateur :

      nb init --ui

      Créer une application Docker en mode non interactif :

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

      Se connecter à une application existante :

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

      Resynchroniser l’état de l’environnement après le démarrage de l’application :

      nb app start -e app1
nb env update app1

      Appeler l’API :

      nb api resource list --resource users -e app1

      Afficher la configuration par défaut du CLI :

      nb config list
nb config get docker.network

      Afficher l’état de la licence commerciale :

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

      Créer et télécharger une sauvegarde :

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

      Restaurer une sauvegarde locale :

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

      Variables d’environnement

      Les variables d’environnement suivantes affectent le comportement du CLI :

      VariableDescription
      NB_CLI_ROOTRépertoire racine où le CLI enregistre la configuration .nocobase et les fichiers des applications locales. Par défaut, il s’agit du répertoire personnel de l’utilisateur courant.
      NB_LOCALELangue des invites du CLI et langue de l’interface d’initialisation locale, prend en charge en-US et zh-CN.
      NB_SESSION_IDID de session du shell actuel ou de l’environnement d’exécution de l’agent. Une fois défini, nb env use et nb env current sont isolés par session.

      Exemple :

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

      Fichier de configuration

      Fichier de configuration par défaut :

      ~/.nocobase/config.json

      Après avoir défini NB_CLI_ROOT=/your/workspace, le chemin du fichier de configuration devient :

      /your/workspace/.nocobase/config.json

      Le CLI est également compatible avec la lecture de l’ancienne configuration de projet dans le répertoire de travail courant.

      Le cache au niveau de la session pour l’environnement courant est enregistré dans :

      .nocobase/sessions/<NB_SESSION_ID>.json

      Le dernier environnement utilisé globalement est enregistré dans le champ lastEnv de config.json. Sans NB_SESSION_ID, le CLI revient à cette valeur globale.

      Le cache des commandes d’exécution est enregistré dans :

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

      Ce fichier est généré ou actualisé par nb env update et sert à mettre en cache les commandes d’exécution synchronisées depuis l’application cible.

      Liens associés