lptech-cli
v1.0.7
Published
CLI tool for LPTech Private scaffolding and upgrade for private purposes. Contact us for more information at https://lptech.asia
Readme
🚀 LPTech CLI Tool
lptech-cli là công cụ dòng lệnh nội bộ của LPTech-Asia, được thiết kế để chuẩn hóa quy trình khởi tạo và bảo trì các dự án frontend. Công cụ hỗ trợ quản lý vòng đời cho nhiều loại ứng dụng khác nhau như MiniBiz và Ecommerce.
✨ Tính Năng Nổi Bật
- Hỗ trợ Đa Ứng dụng: Khởi tạo dự án cho cả
minibizvàecomtừ các kho mã nguồn riêng biệt. - Xác thực Bảo mật: Tự động quản lý Personal Access Token (PAT) của GitHub bằng Keytar (lưu trữ trong Keychain/Credential Manager của hệ điều hành), không lưu plaintext.
- Nâng cấp Thông minh: Tự động phát hiện loại dự án từ
package.jsonđể tải đúng bản cập nhật tương ứng. - Bảo toàn Tùy biến: Cơ chế nâng cấp thông minh giúp ghi đè các file cốt lõi (core) nhưng giữ nguyên các file cấu hình và code tùy chỉnh của dự án.
🛠️ Cài Đặt
Công cụ được phân phối qua GitHub Packages.
1. Cấu hình npm
Tạo hoặc sửa file .npmrc trong thư mục người dùng (~/.npmrc) để trỏ scope @lptech-asia về GitHub Packages:
@lptech-asia:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT(Thay YOUR_GITHUB_PAT bằng token có quyền read:packages)
2. Cài đặt Global
npm install -g @lptech-asia/lptech-cli📖 Hướng Dẫn Sử Dụng
1. Khởi tạo Dự án (init)
Cú pháp: lptech init <app-name> <project-name>
<app-name>: Loại ứng dụng (minibizhoặcecom).<project-name>: Tên thư mục dự án muốn tạo.
Ví dụ:
# Khởi tạo dự án Mini App
lptech init minibiz my-mini-app
# Khởi tạo dự án Ecommerce
lptech init ecom my-web-storeQuy trình thực hiện:
- Hệ thống sẽ kiểm tra PAT GitHub đã lưu trong máy.
- Nếu chưa có hoặc hết hạn, sẽ tự động mở trình duyệt để bạn tạo PAT mới (cần quyền
repo). - Clone mã nguồn từ repository tương ứng (
miniBiz.githoặczmp-ecommerce.git). - Lưu loại ứng dụng (
appType) vàopackage.json. - Tự động chạy
npm install.
2. Nâng cấp Dự án (upgrade)
Cú pháp: lptech upgrade
Chạy lệnh này ngay tại thư mục gốc của dự án.
Cơ chế hoạt động:
- Đọc file
package.jsonđể xác định đây là dự ánminibizhayecom. - Tải template mới nhất từ nhánh
template(cho minibiz) hoặcmain(cho ecom). - Ghi đè các file hệ thống cốt lõi.
- Bỏ qua các file tùy chỉnh (ví dụ:
src/comapp.tsx,package.json,.git...). - Cập nhật dependencies mới nhất.
🧩 Danh sách Ứng dụng Hỗ trợ
| App Name | Repository Nguồn | Branch |
| --- | --- | --- |
| minibiz | github.com/lptech-asia/miniBiz.git | template |
| ecom | github.com/lptech-asia/zmp-ecommerce.git | main |
❓ Xử lý sự cố (Troubleshooting)
Lỗi: "PAT không hợp lệ"
- Token GitHub của bạn đã hết hạn hoặc bị thu hồi.
- Công cụ sẽ tự động nhắc bạn nhập token mới ở lần chạy lệnh tiếp theo.
Lỗi: "Không xác định được loại dự án" khi upgrade
- Kiểm tra file
package.jsontrong dự án. - Đảm bảo có trường
"appType": "minibiz"hoặc"appType": "ecom". Nếu thiếu, hãy thêm thủ công.
Made with ❤️ by LPTech Team
