#NocoBase CLI

#Mô tả

NocoBase CLI (nb) là điểm vào dòng lệnh của NocoBase, dùng để khởi tạo, kết nối và quản lý các ứng dụng NocoBase trong workspace cục bộ.

CLI hỗ trợ hai con đường khởi tạo phổ biến:

• Kết nối tới ứng dụng NocoBase có sẵn và lưu thành CLI env
• Cài đặt ứng dụng NocoBase mới qua Docker, npm hoặc Git rồi lưu thành CLI env

Khi tạo ứng dụng cục bộ mới, nb init cũng có thể cài đặt hoặc cập nhật NocoBase AI coding skills. Nếu bạn muốn bỏ qua bước này, hãy dùng --skip-skills.

#Cách dùng

nb [command]

Lệnh gốc chủ yếu để hiển thị help và phân phối lời gọi tới các nhóm lệnh hoặc lệnh độc lập.

#Nhóm lệnh (Topics)

Các nhóm lệnh sau hiển thị trong nb --help:

#Lệnh (Commands)

Các lệnh độc lập do lệnh gốc trực tiếp đưa ra:

#Xem help

Xem help của lệnh gốc:

nb --help

Xem help của một lệnh hoặc nhóm lệnh:

nb init --help
nb app --help
nb api resource --help

#Ví dụ

Khởi tạo tương tác:

nb init

Khởi tạo bằng form trên trình duyệt:

nb init --ui

Tạo ứng dụng Docker không tương tác:

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

Kết nối ứng dụng có sẵn:

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

Khởi động ứng dụng và làm mới các lệnh runtime:

nb app start -e app1
nb env update app1

Gọi API:

nb api resource list --resource users -e app1

#Biến môi trường

Các biến môi trường sau ảnh hưởng đến hành vi CLI:

Ví dụ:

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

#File cấu hình

File cấu hình mặc định:

~/.nocobase/config.json

Sau khi đặt NB_CLI_ROOT=/your/workspace, đường dẫn cấu hình sẽ thành:

/your/workspace/.nocobase/config.json

CLI cũng đọc tương thích cấu hình project cũ trong thư mục làm việc hiện tại.

Cache lệnh runtime được lưu tại:

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

File này được nb env update sinh ra hoặc làm mới, dùng để cache các lệnh runtime đồng bộ từ ứng dụng đích.

#Liên kết liên quan

• Bắt đầu nhanh
• Cài đặt, nâng cấp và di chuyển
• Biến môi trường toàn cục
• AI Builder
• Phát triển plugin