• Bahasa Indonesia

      • NocoBase CLI

      Deskripsi

      NocoBase CLI (nb) adalah entry point command line dari NocoBase, digunakan untuk menginisialisasi, menghubungkan, dan mengelola aplikasi NocoBase di workspace lokal.

      CLI ini mendukung dua jalur inisialisasi umum:

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

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

      Penggunaan

      nb [command]

      Perintah root sendiri terutama digunakan untuk menampilkan help, dan mendistribusikan panggilan ke grup perintah atau perintah independen.

      Grup Perintah (Topics)

      Grup perintah berikut akan ditampilkan di nb --help:

      Grup PerintahPenjelasan
      nb apiMemanggil API NocoBase melalui CLI.
      nb appMengelola runtime aplikasi: start, stop, restart, logs, dan upgrade.
      nb dbMengelola database bawaan dari env yang dipilih.
      nb envMengelola lingkungan proyek NocoBase, status, detail, dan perintah runtime.
      nb pluginMengelola plugin dari env NocoBase yang dipilih.
      nb scaffoldMenghasilkan scaffold pengembangan plugin NocoBase.
      nb selfMemeriksa atau memperbarui NocoBase CLI itu sendiri.
      nb skillsMemeriksa atau menyinkronkan NocoBase AI coding skills di workspace saat ini.
      nb sourceMengelola proyek source code lokal: download, dev, build, dan test.

      Perintah (Commands)

      Perintah independen yang langsung diekspos oleh perintah root saat ini:

      PerintahPenjelasan
      nb initMenginisialisasi NocoBase, sehingga coding agent dapat terhubung dan bekerja.

      Melihat Bantuan

      Lihat help perintah root:

      nb --help

      Lihat help perintah atau grup perintah tertentu:

      nb init --help
nb app --help
nb api resource --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

      Memulai aplikasi dan memuat ulang perintah runtime:

      nb app start -e app1
nb env update app1

      Memanggil API:

      nb api resource list --resource users -e app1

      Variabel Lingkungan

      Variabel lingkungan berikut akan memengaruhi perilaku CLI:

      VariabelPenjelasan
      NB_CLI_ROOTDirektori root tempat CLI menyimpan konfigurasi .nocobase dan file aplikasi lokal. Defaultnya adalah direktori home pengguna saat ini.
      NB_LOCALEBahasa prompt CLI dan UI inisialisasi lokal, mendukung en-US dan zh-CN.

      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, path file konfigurasi akan menjadi:

      /your/workspace/.nocobase/config.json

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

      Cache perintah runtime disimpan di:

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

      File ini dihasilkan atau dimuat ulang oleh nb env update, digunakan untuk men-cache perintah runtime yang disinkronkan dari aplikasi target.

      Tautan Terkait