@v-miniapp/cli

V-MiniApp CLI là bộ công cụ dòng lệnh mạnh mẽ hỗ trợ nhà phát triển khởi tạo, phát triển, đóng gói và xuất bản Mini App trên hệ sinh thái V-App một cách nhanh chóng và tiêu chuẩn hóa.

📚 Tài liệu chính thức: V-MiniApp Docs

🛠 Cài đặt

Yêu cầu hệ thống: Node.js LTS v22+

npm install -g @v-miniapp/cli

Sau khi cài đặt, bạn có thể sử dụng lệnh v-miniapp-cli trực tiếp từ terminal.

🏗 Các lệnh cơ bản

1. Khởi tạo dự án

Sử dụng lệnh create để bắt đầu một dự án mới từ các template mẫu.

v-miniapp-cli create [project-name]

• CLI sẽ yêu cầu chọn template (sử dụng list để xem các mẫu có sẵn).
• Tự động cấu hình package.json và cài đặt các dependencies cần thiết.

2. Phát triển (Development)

Khởi chạy môi trường giả lập (Simulator) để xem trước ứng dụng trong quá trình code.

v-miniapp-cli dev

• Mini App Server: Chạy tại port 8080 - 8999.
• Simulator Server: Chạy tại port 3000 - 3999.

3. Đóng gói (Build)

Bundle code để sẵn sàng deploy.

v-miniapp-cli build

🔐 Xác thực (Identity)

Để thực hiện các lệnh liên quan đến hệ thống (như dev, deploy), bạn cần đăng nhập thông qua hệ thống VID.

Đăng nhập

v-miniapp-cli login

Đăng xuất

v-miniapp-cli logout

🚀 Xuất bản (Deployment)

Đẩy bản build của bạn lên V-App. Bạn có thể dùng Dev Center để quản lý phiên bản cũng như xuất bản app.

v-miniapp-cli deploy

Quy trình thực hiện:

1. Xác thực thông tin phiên bản trong package.json và app-config.json.
2. Chạy lệnh build tự động.
3. Zip mã nguồn và tệp dist (loại bỏ các file trong .gitignore).
4. Upload lên V-APP.
5. Bạn có thể kiểm thử app của mình tại Dev Assistant. Xem thêm quá trình quản lý phát hành V-MiniApp tại đây.

🩺 Kiểm tra hệ thống

Kiểm tra kết nối

v-miniapp-cli healthcheck

Kiểm tra trạng thái kết nối tới các dịch vụ của V-App (Auth, API, Web) để đảm bảo môi trường phát triển sẵn sàng.

Kiểm tra phiên bản CLI

v-miniapp-cli version-check

So sánh phiên bản hiện tại với phiên bản mới nhất trên NPM và phiên bản tối thiểu bắt buộc từ hệ thống để đảm bảo tính tương thích.

📝 Lưu ý quan trọng

• Để các JS API hoạt động đúng, đảm bảo appIdentifier trong app-config.json được khai báo chính xác với app bạn đã đăng ký tại Dev Center.
• Phiên bản (version) của app được lấy từ field version của package.json.