#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 không gian làm việc cục bộ.

Nó hỗ trợ hai cách khởi tạo phổ biến:

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

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

#Cách dùng

nb [command]

Bản thân lệnh gốc chủ yếu dùng để hiển thị trợ giúp và phân phối lời gọi đến các nhóm lệnh hoặc lệnh độc lập.

#Nhóm lệnh (Topics)

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

#Lệnh (Commands)

Các lệnh độc lập hiện được lệnh gốc hiển thị trực tiếp:

#Xem trợ giúp

Xem trợ giúp của lệnh gốc:

nb --help

Xem trợ giúp của một lệnh hoặc nhóm lệnh:

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

#Ví dụ

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

nb init

Khởi tạo bằng biểu mẫu trên trình duyệt:

nb init --ui

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

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

Kết nối ứng dụng hiện có:

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

Đồng bộ lại trạng thái env sau khi khởi động ứng dụng:

nb app start -e app1
nb env update app1

Gọi API:

nb api resource list --resource users -e app1

Xem cấu hình mặc định của CLI:

nb config list
nb config get docker.network

Xem trạng thái giấy phép thương mại:

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

Tạo và tải xuống bản sao lưu:

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

Khôi phục bản sao lưu cục bộ:

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

#Biến môi trường

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

Ví dụ:

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

#Tệp cấu hình

Tệp cấu hình mặc định:

~/.nocobase/config.json

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

/your/workspace/.nocobase/config.json

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

Bộ nhớ đệm cấp phiên của env hiện tại được lưu tại:

.nocobase/sessions/<NB_SESSION_ID>.json

Env được dùng gần nhất trên toàn cục được lưu trong trường lastEnv của config.json. Khi không có NB_SESSION_ID, CLI sẽ quay lại giá trị toàn cục này.

Bộ nhớ đệm lệnh runtime được lưu tại:

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

Tệp này được tạo hoặc làm mới bởi nb env update, dùng để lưu bộ nhớ đệm các lệnh runtime được đồng bộ từ ứng dụng đích.

#Liên kết liên quan

• Bắt đầu nhanh
• Biến môi trường toàn cục
• Xây dựng bằng AI
• Phát triển plugin