• Bahasa Indonesia

      • NocoBase CLI

      Deskripsi

      NocoBase CLI (nb) adalah titik masuk baris perintah NocoBase, yang digunakan untuk menginisialisasi, menghubungkan, dan mengelola aplikasi NocoBase di ruang kerja lokal.

      Ini mendukung dua jalur inisialisasi umum:

      • Menghubungkan aplikasi NocoBase yang sudah ada, lalu menyimpannya sebagai CLI env
      • Menginstal aplikasi NocoBase baru melalui Docker, npm, atau Git, lalu menyimpannya sebagai CLI env

      Saat membuat aplikasi lokal baru, nb init juga dapat menginstal atau memperbarui skill coding AI NocoBase. Jika perlu melewati langkah ini, Anda dapat menggunakan --skip-skills.

      Penggunaan

      nb [command]

      Perintah root sendiri terutama digunakan untuk menampilkan bantuan dan meneruskan pemanggilan ke grup perintah atau perintah mandiri.

      Grup perintah (Topics)

      nb --help akan menampilkan grup perintah berikut:

      Grup perintahDeskripsi
      nb apiMemanggil API NocoBase melalui CLI.
      nb appMengelola status runtime aplikasi: mulai, berhenti, mulai ulang, log, dan upgrade.
      nb backupMembuat cadangan dan mengunduhnya ke lokal, atau memulihkan file cadangan lokal ke env target.
      nb configMengelola konfigurasi default CLI.
      nb dbMengelola basis data bawaan dari env yang dipilih.
      nb envMengelola lingkungan proyek NocoBase, env saat ini, status, detail, dan perintah runtime.
      nb licenseMengelola lisensi komersial dan plugin berlisensi.
      nb pluginMengelola plugin dari env NocoBase yang dipilih.
      nb scaffoldMenghasilkan scaffold pengembangan plugin NocoBase.
      nb selfMemeriksa atau memperbarui NocoBase CLI itu sendiri.
      nb sessionMengonfigurasi NB_SESSION_ID agar current env terisolasi berdasarkan shell atau agent runtime.
      nb skillsMemeriksa atau menyinkronkan skill coding AI NocoBase di ruang kerja saat ini.
      nb sourceMengelola proyek kode sumber lokal: unduh, pengembangan, build, dan pengujian.

      Perintah (Commands)

      Perintah mandiri yang saat ini diekspos langsung oleh perintah root:

      PerintahDeskripsi
      nb initMenginisialisasi NocoBase agar coding agent dapat terhubung dan bekerja.

      Melihat bantuan

      Melihat bantuan untuk perintah root:

      nb --help

      Melihat bantuan untuk perintah atau grup perintah tertentu:

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

      Contoh

      Inisialisasi interaktif:

      nb init

      Inisialisasi menggunakan formulir browser:

      nb init --ui

      Membuat aplikasi Docker secara non-interaktif:

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

      Menghubungkan aplikasi yang sudah ada:

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

      Menyinkronkan ulang status env setelah aplikasi dijalankan:

      nb app start -e app1
nb env update app1

      Memanggil API:

      nb api resource list --resource users -e app1

      Melihat konfigurasi default CLI:

      nb config list
nb config get docker.network

      Melihat status lisensi komersial:

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

      Membuat dan mengunduh cadangan:

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

      Memulihkan cadangan lokal:

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

      Variabel lingkungan

      Variabel lingkungan berikut memengaruhi perilaku CLI:

      VariabelDeskripsi
      NB_CLI_ROOTDirektori root tempat CLI menyimpan konfigurasi .nocobase dan file aplikasi lokal. Default-nya adalah direktori home pengguna saat ini.
      NB_LOCALEBahasa prompt CLI dan bahasa UI inisialisasi lokal, mendukung en-US dan zh-CN.
      NB_SESSION_IDID sesi dari shell saat ini atau agent runtime. Setelah disetel, nb env use dan nb env current akan diisolasi per sesi.

      Contoh:

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

      File konfigurasi

      File konfigurasi default:

      ~/.nocobase/config.json

      Setelah mengatur NB_CLI_ROOT=/your/workspace, jalur file konfigurasi akan menjadi:

      /your/workspace/.nocobase/config.json

      CLI juga kompatibel untuk membaca konfigurasi project lama di direktori kerja saat ini.

      Cache tingkat sesi untuk env saat ini disimpan di:

      .nocobase/sessions/<NB_SESSION_ID>.json

      Env terakhir yang digunakan secara global disimpan di field lastEnv dalam config.json. Jika tidak ada NB_SESSION_ID, CLI akan kembali ke nilai global ini.

      Cache perintah runtime disimpan di:

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

      File ini dibuat atau diperbarui oleh nb env update, dan digunakan untuk menyimpan cache perintah runtime yang disinkronkan dari aplikasi target.

      Tautan terkait