nb init

Khởi tạo workspace hiện tại để coding agent có thể kết nối và sử dụng NocoBase. nb init có thể kết nối đến ứng dụng có sẵn hoặc cài đặt một ứng dụng mới qua Docker, npm hoặc Git.

Cách dùng

nb init [flags]

Mô tả

nb init hỗ trợ ba chế độ tương tác:

  • Chế độ mặc định: bạn nhập từng bước trong terminal.
  • --ui: mở form trên trình duyệt cục bộ để hoàn tất quá trình khởi tạo.
  • --yes: bỏ qua các câu hỏi và dùng giá trị mặc định. Chế độ này bắt buộc truyền --env <envName> và sẽ tạo một ứng dụng cục bộ mới.

Mặc định, nb init sẽ cài đặt hoặc cập nhật NocoBase AI coding skills khi khởi tạo hoặc khôi phục khởi tạo. Nếu bạn đã tự quản lý skills hoặc đang chạy trong môi trường CI, offline, hãy dùng --skip-skills để bỏ qua bước này.

Nếu quá trình khởi tạo bị gián đoạn sau khi cấu hình env đã được lưu, bạn có thể dùng --resume để tiếp tục:

nb init --env app1 --resume

Tham số

Tham sốKiểuMô tả
--yes, -ybooleanBỏ qua câu hỏi, dùng flags và giá trị mặc định
--env, -estringTên env cho lần khởi tạo này, bắt buộc với chế độ --yes--resume
--uibooleanMở wizard trực quan trên trình duyệt, không thể dùng cùng --yes
--verbosebooleanHiển thị output chi tiết của lệnh
--skip-skillsbooleanBỏ qua việc cài đặt hoặc cập nhật NocoBase AI coding skills trong quá trình khởi tạo
--ui-hoststringĐịa chỉ bind cho service cục bộ của --ui, mặc định 127.0.0.1
--ui-portintegerPort cho service cục bộ của --ui, 0 nghĩa là tự chọn
--localestringNgôn ngữ của CLI prompt và UI: en-US hoặc zh-CN
--api-base-url, -ustringĐịa chỉ API NocoBase, bao gồm tiền tố /api
--auth-type, -astringPhương thức xác thực: token hoặc oauth
--access-token, -tstringAPI key hoặc access token dùng cho phương thức token
--resumebooleanDùng lại workspace env config đã lưu để tiếp tục khởi tạo
--lang, -lstringNgôn ngữ của ứng dụng NocoBase sau khi cài đặt
--force, -fbooleanCấu hình lại env có sẵn và thay thế tài nguyên runtime xung đột nếu cần
--app-root-pathstringThư mục source code của ứng dụng cục bộ npm/Git, mặc định ./<envName>/source/
--app-portstringPort của ứng dụng cục bộ, mặc định 13000, chế độ --yes sẽ tự chọn port khả dụng
--storage-pathstringThư mục lưu file upload và data của database, mặc định ./<envName>/storage/
--root-usernamestringTên đăng nhập admin ban đầu
--root-emailstringEmail admin ban đầu
--root-passwordstringMật khẩu admin ban đầu
--root-nicknamestringBiệt danh admin ban đầu
--builtin-db, --no-builtin-dbbooleanCó tạo database tích hợp do CLI quản lý hay không
--db-dialectstringLoại database: postgres, mysql, mariadb, kingbase
--builtin-db-imagestringImage container cho database tích hợp
--db-hoststringĐịa chỉ database
--db-portstringPort database
--db-databasestringTên database
--db-userstringTên người dùng database
--db-passwordstringMật khẩu database
--fetch-sourcebooleanTải file ứng dụng hoặc Docker image trước khi cài đặt
--source, -sstringCách lấy NocoBase: docker, npm hoặc git
--version, -vstringTham số phiên bản: phiên bản npm, tag Docker image hoặc Git ref
--replace, -rbooleanThay thế khi thư mục đích đã tồn tại
--dev-dependencies, -DbooleanCó cài devDependencies khi dùng npm/Git hay không
--output-dir, -ostringThư mục đích để tải về, hoặc thư mục lưu Docker tarball
--git-urlstringĐịa chỉ Git repository
--docker-registrystringTên Docker registry, không bao gồm tag
--docker-platformstringPlatform Docker image: auto, linux/amd64, linux/arm64
--docker-save, --no-docker-savebooleanCó lưu Docker image thành tarball sau khi pull hay không
--npm-registrystringRegistry npm cho việc tải xuống và cài đặt dependency của npm/Git
--build, --no-buildbooleanCó build sau khi cài đặt dependency npm/Git hay không
--build-dtsbooleanCó sinh file khai báo TypeScript khi build npm/Git hay không

Ví dụ

nb init
nb init --ui
nb init --env app1 --yes
nb init --env app1 --yes --skip-skills
nb init --env app1 --resume
nb init --env app1 --resume --skip-skills
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source npm --version alpha --app-port 13080
nb init --env app1 --yes --source git --version fix/cli-v2
nb init --ui --ui-port 3000

Lệnh liên quan