nb init

Menginisialisasi workspace saat ini sehingga coding agent dapat terhubung dan menggunakan NocoBase. nb init dapat menghubungkan aplikasi yang sudah ada, atau menginstal aplikasi baru melalui Docker, npm, atau Git.

Penggunaan

nb init [flags]

Penjelasan

nb init mendukung tiga mode prompt:

  • Mode default: mengisi langkah demi langkah di terminal.
  • --ui: membuka formulir browser lokal untuk menyelesaikan alur panduan.
  • --yes: melewati prompt dan menggunakan nilai default. Mode ini harus disertai --env <envName>, dan akan membuat aplikasi lokal baru.

Secara default, nb init akan menginstal atau memperbarui NocoBase AI coding skills saat menginisialisasi atau melanjutkan inisialisasi. Jika Anda sudah mengelola skills sendiri, atau menjalankan di lingkungan CI atau offline, Anda dapat menggunakan --skip-skills untuk melewati langkah ini.

Jika inisialisasi terganggu setelah konfigurasi env tersimpan, Anda dapat menggunakan --resume untuk melanjutkan:

nb init --env app1 --resume

Parameter

ParameterTipePenjelasan
--yes, -ybooleanLewati prompt, gunakan flags dan nilai default
--env, -estringNama env untuk inisialisasi ini, wajib diisi pada mode --yes dan --resume
--uibooleanBuka wizard visual browser, tidak dapat digunakan bersama --yes
--verbosebooleanTampilkan output perintah secara detail
--skip-skillsbooleanLewati instalasi atau pembaruan NocoBase AI coding skills selama inisialisasi
--ui-hoststringAlamat binding layanan lokal --ui, default 127.0.0.1
--ui-portintegerPort layanan lokal --ui, 0 berarti dialokasikan otomatis
--localestringBahasa prompt CLI dan UI: en-US atau zh-CN
--api-base-url, -ustringAlamat API NocoBase, termasuk prefix /api
--auth-type, -astringMetode autentikasi: token atau oauth
--access-token, -tstringAPI key atau access token yang digunakan untuk metode autentikasi token
--resumebooleanGunakan kembali workspace env config yang tersimpan untuk melanjutkan inisialisasi
--lang, -lstringBahasa aplikasi NocoBase setelah instalasi
--force, -fbooleanKonfigurasi ulang env yang sudah ada, dan ganti resource runtime yang konflik jika diperlukan
--app-root-pathstringDirektori source code aplikasi npm/Git lokal, default ./<envName>/source/
--app-portstringPort aplikasi lokal, default 13000, mode --yes akan otomatis memilih port yang tersedia
--storage-pathstringDirektori untuk file upload dan data database yang dikelola, default ./<envName>/storage/
--root-usernamestringUsername admin awal
--root-emailstringEmail admin awal
--root-passwordstringPassword admin awal
--root-nicknamestringNickname admin awal
--builtin-db, --no-builtin-dbbooleanApakah membuat database bawaan yang dikelola CLI
--db-dialectstringTipe database: postgres, mysql, mariadb, kingbase
--builtin-db-imagestringImage container untuk database bawaan
--db-hoststringAlamat database
--db-portstringPort database
--db-databasestringNama database
--db-userstringUser database
--db-passwordstringPassword database
--fetch-sourcebooleanDownload file aplikasi atau pull image Docker sebelum instalasi
--source, -sstringCara mendapatkan NocoBase: docker, npm, atau git
--version, -vstringParameter versi: versi npm, tag image Docker, atau ref Git
--replace, -rbooleanGanti jika direktori target sudah ada
--dev-dependencies, -DbooleanApakah menginstal devDependencies saat instalasi npm/Git
--output-dir, -ostringDirektori target download, atau direktori untuk menyimpan tarball Docker
--git-urlstringAlamat repository Git
--docker-registrystringNama registry image Docker, tanpa tag
--docker-platformstringPlatform image Docker: auto, linux/amd64, linux/arm64
--docker-save, --no-docker-savebooleanApakah menyimpan sebagai tarball setelah pull image Docker
--npm-registrystringRegistry yang digunakan untuk download dan instalasi dependensi npm/Git
--build, --no-buildbooleanApakah build setelah instalasi dependensi npm/Git
--build-dtsbooleanApakah menghasilkan file deklarasi TypeScript saat build npm/Git

Contoh

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

Perintah Terkait