nb api Perintah Dinamis

Selain nb api resource, di bawah nb api juga terdapat sekelompok perintah yang dihasilkan secara dinamis berdasarkan OpenAPI Schema aplikasi NocoBase. Perintah ini dihasilkan dan di-cache saat pertama kali menjalankan nb env add atau nb env update.

Grup Umum

Grup PerintahPenjelasan
nb api aclManajemen permission: role, permission resource, dan permission operasi
nb api api-keysManajemen API Key
nb api appManajemen aplikasi
nb api authenticatorsManajemen autentikasi: password, SMS, SSO, dll
nb api data-modelingPemodelan data: data source, tabel data, dan field
nb api file-managerManajemen file: layanan storage dan attachment
nb api flow-surfacesOrkestrasi halaman: halaman, blok, field, dan action
nb api system-settingsPengaturan sistem: judul, Logo, bahasa, dll
nb api theme-editorManajemen tema: warna, ukuran, dan pergantian tema
nb api workflowWorkflow: manajemen alur otomatis

Grup dan perintah yang sebenarnya tersedia bergantung pada versi aplikasi NocoBase yang terhubung dan plugin yang diaktifkan. Jalankan perintah berikut untuk melihat perintah yang didukung oleh aplikasi saat ini:

nb api --help
nb api <topic> --help

Parameter Request Body

Perintah dinamis dengan request body mendukung:

ParameterTipePenjelasan
--bodystringRequest body dalam bentuk string JSON
--body-filestringPath file JSON

--body dan --body-file saling eksklusif.

Perintah API dinamis juga mendukung:

  • --env, -e: nama env CLI tujuan permintaan; jika dihilangkan, env saat ini akan digunakan
  • --yes, -y: saat --env yang diberikan secara eksplisit menargetkan env yang berbeda dari env saat ini, lewati konfirmasi interaktif

Jika Anda memberikan --env secara eksplisit dan nilainya berbeda dari env saat ini, CLI akan meminta konfirmasi terlebih dahulu. Pada terminal non-interaktif atau sesi AI agent, tambahkan --yes sendiri atau jalankan nb env use <name> terlebih dahulu lalu coba lagi.

Perintah Terkait