🚀 ABC — Platform Services CLI Generator

🌟 Tổng quan

ABC — Platform Services CLI là một công cụ mạnh mẽ được thiết kế để khởi tạo dự án nhanh chóng trong khi vẫn tuân thủ các tiêu chuẩn cao của ABC. Cài đặt một lần, sử dụng mọi nơi để tối ưu hóa quy trình làm việc của bạn trên tất cả các nền tảng công nghệ được chúng tôi hỗ trợ.

✨ Các tính năng chính

• 🚀 Khởi tạo cực nhanh: Tạo một dự án đầy đủ từ kho lưu trữ mẫu (template) riêng tư chỉ trong vài giây.
• 🔐 Xác thực thông minh: Tự động giải quyết và quản lý GitHub Token.
• 🏗️ Hỗ trợ đa nền tảng: Các bản mẫu cho Web, Admin, Mobile và Backend.
• 🛠️ Đa dự án: Chọn và khởi tạo nhiều loại dự án cùng một lúc.

🛠 Điều kiện tiên quyết

• Node.js: phiên bản v18+
• Git: Đã được cài đặt và có sẵn trong PATH
• Quyền truy cập GitHub: Một tài khoản GitHub có quyền truy cập vào các bản mẫu riêng tư của ABC — Platform Services.

🚀 Bắt đầu sử dụng

1️⃣ Cài đặt toàn cục (một lần duy nhất)

# npm
npm install -g abc-cli-generator

# pnpm (khuyên dùng)
pnpm install -g abc-cli-generator

# yarn (CHỈ dành cho v1 classic)
yarn global add abc-cli-generator

[!NOTE] Người dùng Yarn v2+ (Berry): Lệnh yarn global add đã chính thức bị nhóm phát triển loại bỏ. Vui lòng sử dụng npm install -g để cài đặt công cụ này cục bộ, hoặc chạy tạm thời không cần cài đặt qua lệnh yarn dlx abc-cli-generator.

2️⃣ Bắt đầu phát triển

abc init       # Khởi tạo dự án mới
abc auth       # Quản lý GitHub Token của bạn
abc --help     # Hiển thị tất cả các lệnh có sẵn
abc --version  # Hiển thị phiên bản CLI

[!NOTE] Trong lần chạy đầu tiên, abc init sẽ tự động yêu cầu bạn nhập GitHub Token nếu không tìm thấy. Token sẽ được xác thực và lưu cục bộ — không bao giờ bị hỏi lại.

🔑 Thiết lập GitHub Token

Truy cập https://github.com/settings/tokens → Generate new token (classic)

Các quyền cần thiết (Required scopes):

| Quyền | Mục đích | | :--- | :--- | | repo | Clone các kho lưu trữ riêng tư | | read:packages | Tải xuống các gói từ GitHub Package Registry |

[!TIP] Đặt thời hạn (expiration) là 1 năm cho tiện lợi. Bạn luôn có thể cập nhật thông qua lệnh abc auth → Set new token.

🔐 Quản lý GitHub Token

CLI giải quyết token theo thứ tự sau:

1. Biến môi trường: ABC_GITHUB_TOKEN hoặc GITHUB_TOKEN
2. Cấu hình npm: .npmrc (//npm.pkg.github.com/:_authToken)
3. Token đã lưu: ~/.abc/config.json
4. Lời nhắc tương tác: Tự động nhắc nếu không tìm thấy token → xác thực → lưu

[!NOTE] Token được lưu an toàn vào ~/.abc/config.json. Bạn sẽ không bao giờ bị hỏi lần thứ hai.

Quản lý token của bạn bất cứ lúc nào

abc auth

| Tùy chọn | Mô tả | | :--- | :--- | | Show current status | Hiển thị nguồn, giá trị ẩn của token, và kiểm tra hiệu lực | | Set new token | Xóa thông tin xác thực cũ và thiết lập token mới đã xác minh | | Remove all tokens | Xóa an toàn các token khỏi cấu hình và .npmrc |

🏗 Các nền tảng công nghệ được hỗ trợ

| Danh mục | Công nghệ | Kho lưu trữ bản mẫu (Template Repository) | | :--- | :--- | :--- | | 🌐 Web App | NextJS | template-fe-website-nextjs | | 🛠 Admin Portal | React (Vite) | template-fe-admin-portal | | 📱 Mobile App | React Native | template-fe-mobile-react-native | | ⚙️ Backend | NestJS | template-be-nestjs |

[!TIP] Bạn có thể chọn nhiều loại dự án cùng lúc — mỗi dự án sẽ được clone vào thư mục riêng.

💡 Xử lý sự cố

• Token bị hỏi mỗi khi chạy → Chạy abc auth → Show current token để kiểm tra xem token đang được đọc từ đâu.
• Lỗi Clone → Đảm bảo token có quyền repo và read:packages.
• Git Credential popup → Thiết lập biến môi trường ABC_GITHUB_TOKEN.
• Vấn đề với yarn v1 trên Admin Portal → Sử dụng pnpm hoặc npm để thay thế.
• Không tìm thấy lệnh sau khi cài đặt → Chạy pnpm setup sau đó mở một terminal mới.

🛡 Bảo mật là trên hết

• ❌ Không bao giờ commit GitHub token của bạn vào hệ thống quản lý mã nguồn.
• ❌ Không bao giờ chia sẻ Personal Access Token của bạn với bất kỳ ai.
• ✅ Token chỉ được lưu trữ cục bộ trên máy của bạn (~/.abc/config.json).
• ✅ CLI không bao giờ ghi log hoặc truyền token của bạn đến các máy chủ bên ngoài (ngoại trừ GitHub để xác thực).