nb init

Initialiser l'espace de travail courant pour qu'un coding agent puisse se connecter à NocoBase et l'utiliser. nb init permet aussi bien de connecter une application existante que d'en installer une nouvelle via Docker, npm ou Git.

Utilisation

nb init [flags]

Description

nb init prend en charge trois modes d'invite :

  • Mode par défaut : remplissage progressif dans le terminal.
  • --ui : ouvre un formulaire dans le navigateur local pour suivre le parcours guidé.
  • --yes : ignore les invites et utilise les valeurs par défaut. Ce mode requiert --env <envName> et crée toujours une nouvelle application locale.

Par défaut, nb init installe ou met à jour les NocoBase AI coding skills lors de l'initialisation ou de sa reprise. Si vous gérez les skills vous-même, ou si vous travaillez en CI ou hors ligne, utilisez --skip-skills pour ignorer cette étape.

Si l'initialisation est interrompue après l'enregistrement de la configuration de l'env, vous pouvez la reprendre avec --resume :

nb init --env app1 --resume

Paramètres

ParamètreTypeDescription
--yes, -ybooleanIgnorer les invites et utiliser les flags ainsi que les valeurs par défaut
--env, -estringNom de l'env pour cette initialisation, requis avec --yes et --resume
--uibooleanOuvrir l'assistant visuel dans le navigateur, incompatible avec --yes
--verbosebooleanAfficher la sortie détaillée des commandes
--skip-skillsbooleanIgnorer l'installation ou la mise à jour des NocoBase AI coding skills pendant l'initialisation
--ui-hoststringAdresse de bind du service local pour --ui, par défaut 127.0.0.1
--ui-portintegerPort du service local pour --ui, 0 pour une attribution automatique
--localestringLangue des messages CLI et de l'UI : en-US ou zh-CN
--api-base-url, -ustringAdresse de l'API NocoBase, incluant le préfixe /api
--auth-type, -astringMéthode d'authentification : token ou oauth
--access-token, -tstringAPI key ou access token utilisé par la méthode token
--resumebooleanRéutiliser la configuration d'env enregistrée dans le workspace pour reprendre l'initialisation
--lang, -lstringLangue de l'application NocoBase après installation
--force, -fbooleanReconfigurer un env existant et remplacer si nécessaire les ressources runtime en conflit
--app-root-pathstringRépertoire des sources locales d'application npm/Git, par défaut ./<envName>/source/
--app-portstringPort de l'application locale, par défaut 13000. En mode --yes, un port disponible est sélectionné automatiquement
--storage-pathstringRépertoire des fichiers téléversés et des données de la base hébergée, par défaut ./<envName>/storage/
--root-usernamestringNom d'utilisateur de l'administrateur initial
--root-emailstringE-mail de l'administrateur initial
--root-passwordstringMot de passe de l'administrateur initial
--root-nicknamestringPseudo de l'administrateur initial
--builtin-db, --no-builtin-dbbooleanCréer ou non la base de données intégrée gérée par le CLI
--db-dialectstringType de base : postgres, mysql, mariadb, kingbase
--builtin-db-imagestringImage du conteneur de la base de données intégrée
--db-hoststringHôte de la base de données
--db-portstringPort de la base de données
--db-databasestringNom de la base de données
--db-userstringUtilisateur de la base de données
--db-passwordstringMot de passe de la base de données
--fetch-sourcebooleanTélécharger les fichiers de l'application ou récupérer l'image Docker avant l'installation
--source, -sstringMode d'obtention de NocoBase : docker, npm ou git
--version, -vstringVersion : version npm, tag d'image Docker ou ref Git
--replace, -rbooleanRemplacer le répertoire cible s'il existe déjà
--dev-dependencies, -DbooleanInstaller les devDependencies lors d'une installation npm/Git
--output-dir, -ostringRépertoire de destination du téléchargement, ou répertoire où enregistrer le tarball Docker
--git-urlstringURL du dépôt Git
--docker-registrystringNom du registry d'image Docker, sans le tag
--docker-platformstringPlateforme de l'image Docker : auto, linux/amd64, linux/arm64
--docker-save, --no-docker-savebooleanEnregistrer ou non l'image Docker comme tarball après récupération
--npm-registrystringRegistry npm utilisé pour les téléchargements et l'installation des dépendances npm/Git
--build, --no-buildbooleanLancer la build après l'installation des dépendances npm/Git
--build-dtsbooleanGénérer les fichiers de déclaration TypeScript lors de la build npm/Git

Exemples

nb init
nb init --ui
nb init --env app1 --yes
nb init --env app1 --yes --skip-skills
nb init --env app1 --resume
nb init --env app1 --resume --skip-skills
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source npm --version alpha --app-port 13080
nb init --env app1 --yes --source git --version fix/cli-v2
nb init --ui --ui-port 3000

Commandes connexes