#nb init

Initialisiert den aktuellen Workspace, damit der coding agent sich mit NocoBase verbinden und es verwenden kann.

nb init kann eine neue lokale NocoBase-App installieren oder die Verbindungsinformationen einer bestehenden App speichern.

Außerdem synchronisiert nb init standardmäßig auch die NocoBase AI coding skills. Nur wenn du skills bereits selbst verwaltest oder in CI bzw. in einer Offline-Umgebung arbeitest, musst du --skip-skills hinzufügen.

#Verwendung

nb init [flags]

#Interaktive Modi

nb init unterstützt drei interaktive Modi:

• nb init: führt die Einrichtung Schritt für Schritt im Terminal durch
• nb init --ui: öffnet ein Formular im lokalen Browser und führt das Setup mit einem visuellen Assistenten durch
• nb init --yes --env app1: überspringt Eingabeaufforderungen und verwendet direkt die Flags; nicht explizit übergebene Parameter werden mit Standardwerten behandelt

Der Modus --yes eignet sich für Skripte, CI/CD oder andere nicht interaktive Szenarien. In diesem Modus ist --env <envName> erforderlich. Üblicherweise wird standardmäßig eine neue lokale App installiert; wenn du --source nicht angibst, wird standardmäßig docker als Installationsquelle verwendet.

#Unterbrochene Initialisierung fortsetzen

Installationsabläufe speichern zuerst die env-Konfiguration und führen danach Download, Datenbank- und App-Installation aus. Wenn der Vorgang zwischendurch fehlschlägt, kannst du fortfahren:

nb init --env app1 --resume

--resume gilt nur für Initialisierungsabläufe, bei denen die env-Konfiguration bereits gespeichert wurde, und --env muss ausdrücklich angegeben werden.

#Zuerst das env vorbereiten und die App später installieren

--prepare-only ist für Abläufe gedacht, bei denen zuerst das env vorbereitet, dann die Lizenz aktiviert und erst danach die App installiert und gestartet wird.

Wenn du zuerst die env-Konfiguration speichern, den Quellcode oder das Image vorbereiten und die Datenbank einrichten möchtest, die eigentliche App-Installation und den ersten Start aber zunächst verschieben willst, kannst du Folgendes verwenden:

nb init --env app1 --prepare-only
nb init --env app1 --prepare-only --ui
nb init --env app1 --prepare-only --yes

Dieser Modus ist für lokale Installationsabläufe verfügbar, einschließlich des --ui-Assistenten. Für Remote-Verbindungsabläufe ist er nicht verfügbar. Die CLI speichert das aktuelle env im Status prepared, sodass du später mit einem Ablauf wie diesem fortfahren kannst:

nb license activate --env app1
nb app start --env app1

Danach schließt nb app start die Erstinstallation ab und wechselt das env vom prepared-Status in den normalen installed-Status.

#Hinweise zum Installationsverzeichnis

Den vollständigen Pfad kannst du mit nb env info app1 --field app.appPath anzeigen.

Standardmäßig organisiert die CLI lokale Dateien unter app-path nach dieser Konvention:

<app-path>/
├── source/   # Standardverzeichnis für den App-Quellcode oder heruntergeladene Inhalte
├── storage/  # Laufzeitdatenverzeichnis
└── .env      # optionale Datei mit Umgebungsvariablen der App

In der Regel gilt:

• source/ entspricht hauptsächlich dem lokalen App-Verzeichnis für npm-/Git-envs. Bei Docker-envs behält die CLI diese Standardpfadableitung ebenfalls bei, allerdings musst du dich in den meisten Fällen nicht manuell darum kümmern. Achte bei Upgrades besonders darauf: Das Verzeichnis source/ wird gelöscht und erneut heruntergeladen. Lege hier also keine Dateien ab, die erhalten bleiben müssen
• storage/ dient zum Speichern von Laufzeitdaten wie eingebetteten Datenbankdaten, Plugins, Logs usw.
• .env ist eine optionale Datei für Umgebungsvariablen der App. Du musst sie nur in <app-path>/.env anlegen, wenn du Umgebungsvariablen anpassen möchtest; falls diese Datei vorhanden ist, wird sie bei den Installationsquellen Docker, npm und Git standardmäßig eingelesen

Dies beschreibt die Standardverzeichnis-Konvention der CLI. Je nach Installationsquelle, Plugins und Laufzeitphase können die tatsächlich erzeugten Verzeichnisinhalte abweichen.

#Hinweise

#Schnelle Orientierung nach Steps

Je nach Setup-Pfad unterscheiden sich die angezeigten Steps leicht. Wenn du zum Beispiel eine bestehende App verbindest, werden normalerweise nur Getting started und Remote connection verwendet.

Wenn du dem lokalen UI-Assistenten Schritt für Schritt folgst, kannst du dich mit der folgenden Tabelle schnell orientieren:

#Parameter

Es gibt viele Parameter; nach Nutzungsszenarien aufgeteilt sind sie übersichtlicher.

Der „Standardwert“ unten steht für den Wert oder das Verhalten, das nb init normalerweise verwendet, wenn du den Parameter weglässt.

#Grundlagen und Interaktion

#Verbindung mit einer bestehenden App

#Grundlegende Parameter für die lokale Installation

#Datenbankparameter

#Parameter für Download und Quellcode

#Beispiele

Die gebräuchlichsten Verwendungsweisen sind die folgenden.

#Die Einrichtung Schritt für Schritt im Terminal durchführen

nb init

#Den Assistenten im lokalen Browser öffnen

nb init --ui
nb init --ui --ui-port 3000

#Zuerst vorbereiten, dann die Lizenz aktivieren und später starten

nb init --env app1 --prepare-only
nb license activate --env app1
nb app start --env app1

#Eine neue lokale App nicht interaktiv installieren

Wenn du --source nicht angibst, wird normalerweise Docker als Installationsquelle verwendet.

nb init --env app1 --yes
nb init --env app1 --yes --source docker --version latest
nb init --env app1 --yes --source docker --version beta
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source docker --version main \
  --docker-registry registry.cn-beijing.aliyuncs.com/nocobase/nocobase
nb init --env app1 --yes --source npm --version latest
nb init --env app1 --yes --source npm --version beta
nb init --env app1 --yes --source npm --version alpha
nb init --env app1 --yes --source npm --version beta --app-port 13080
nb init --env app1 --yes --source git --version latest
nb init --env app1 --yes --source git --version beta
nb init --env app1 --yes --source git --version alpha
nb init --env app1 --yes --source git --version feat/plugin-workflow-timeout
nb init --env app1 --yes --source git --version latest \
  --git-url https://gitee.com/nocobase/nocobase.git

#Schnell installieren und basic-Authentifizierung verwenden

Wenn du im nicht interaktiven Modus schnell eine lokale App installieren und direkt nach der Installation basic-Authentifizierung speichern möchtest, kannst du es auch so schreiben. Dann musst du keinen Browser mehr öffnen, um OAuth abzuschließen.

Wenn du das Standard-Administratorkonto des Modus --yes beibehältst, ist dies die kürzeste Form.

Falls nichts angegeben wird, lautet das Standard-Administratorkonto nocobase und das Standardpasswort admin123:

nb init --env app1 --yes --auth-type basic

Wenn du gleichzeitig auch das Administratorkonto anpassen möchtest, kannst du es so schreiben:

nb init --env app1 --yes \
  --auth-type basic \
  --root-username admin \
  --root-password secret123

#Mit einer bestehenden App verbinden

Standardmäßig genügt OAuth. Wenn es in bestimmten CI/CD-Szenarien unpraktisch ist, einen Browser zu öffnen, kannst du auch direkt basic-Authentifizierung speichern; wenn du bereits ein API-Token hast, kannst du auch direkt token-Authentifizierung speichern.

nb init --env staging --yes \
  --api-base-url https://demo.example.com/api

nb init --env staging --yes \
  --api-base-url https://demo.example.com/api \
  --auth-type basic \
  --username <username> \
  --password <password>

nb init --env staging --yes \
  --api-base-url https://demo.example.com/api \
  --auth-type token \
  --access-token <token>

nb init --env staging --yes \
  --api-base-url https://demo.example.com/api \
  --auth-type oauth \
  --skip-auth

#Datenbankbenennung anpassen

Wenn du ein PostgreSQL-Schema, ein Tabellenpräfix oder Unterstrich-Schreibweise angeben musst, kannst du die Parameter so übergeben:

nb init --env app1 --yes \
  --db-dialect postgres \
  --db-schema public \
  --db-table-prefix nb_ \
  --db-underscored

#Eine zuvor unterbrochene Initialisierung fortsetzen

nb init --env app1 --resume

#Detaillierte Logs zur Fehlerbehebung anzeigen

nb init --env app1 --yes --source docker --version latest --verbose

#Verwandte Befehle

• nb env add
• nb env auth
• nb source download