Cài đặt

Hướng dẫn này sẽ giúp bạn cài đặt TOSE CLI trên hệ thống.

Yêu cầu

Trước khi cài đặt TOSE CLI, đảm bảo bạn có:

• Node.js phiên bản 14.0.0 trở lên
• npm hoặc yarn package manager
• Git (tùy chọn, cho tính năng tích hợp Git)
• Tài khoản TOSE với API key

Kiểm tra phiên bản Node.js

Chạy node --version để kiểm tra phiên bản Node.js. Nếu cần cài đặt hoặc nâng cấp Node.js, truy cập nodejs.org.

Cài đặt qua npm

Cài đặt toàn cục (Khuyến nghị)

Cài đặt TOSE CLI toàn cục để sử dụng lệnh tose từ mọi nơi:

npm install -g @tosesh/tose

Xác minh cài đặt:

tose --version

Bạn sẽ thấy đầu ra như:

1.0.0

Cài đặt cục bộ

Cho cài đặt theo dự án:

npm install @tosesh/tose

Sau đó sử dụng qua npx:

npx tose up

Hoặc thêm scripts vào package.json:

{
  "scripts": {
    "deploy": "tose up",
    "status": "tose status",
    "logs": "tose logs"
  }
}

Cài đặt qua Yarn

Cài đặt toàn cục

yarn global add @tosesh/tose

Cài đặt cục bộ

yarn add @tosesh/tose

Xác minh cài đặt

Sau khi cài đặt, xác minh TOSE CLI hoạt động:

tose --help

Bạn sẽ thấy đầu ra trợ giúp:

Usage: tose [options] [command]

TOSE CLI - Deploy and manage your applications

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  up              Deploy or manage your project
  status          Check deployment status
  logs            View deployment logs
  down            Stop deployment
  help [command]  display help for command

Lấy API Key

Để sử dụng TOSE CLI, bạn cần một API key:

1. Đăng ký hoặc đăng nhập tại https://tose.sh
2. Điều hướng đến Settings > API Keys
3. Nhấp Create New API Key
4. Sao chép key (bắt đầu bằng tose_sk_)
5. Giữ an toàn - bạn sẽ cần nó cho thiết lập lần đầu

Giữ API Key an toàn

Không bao giờ commit API key vào version control hoặc chia sẻ công khai. TOSE CLI lưu trữ nó an toàn trong ~/.tose/config.json.

Thiết lập lần đầu

Khi chạy lần đầu, TOSE CLI sẽ nhắc nhập API key:

tose up

Làm theo các gợi ý:

1. Nhập API Key: Dán API key của bạn
2. Chọn Workspace: Chọn hoặc tạo workspace
3. Tiếp tục thiết lập triển khai

API key và tùy chọn workspace sẽ được lưu cục bộ cho việc sử dụng sau.

Vị trí cấu hình

TOSE CLI lưu trữ cấu hình trong:

~/.tose/config.json

Ví dụ cấu hình:

{
  "apiKey": "tose_sk_xxxxxxxxxxxxx",
  "workspaceId": "ws_123456",
  "baseUrl": "https://api.tose.sh"
}

Cập nhật TOSE CLI

Để cập nhật lên phiên bản mới nhất:

npm

npm update -g @tosesh/tose

yarn

yarn global upgrade @tosesh/tose

Kiểm tra phiên bản mới:

tose --version

Gỡ cài đặt

Để xóa TOSE CLI:

npm

npm uninstall -g @tosesh/tose

yarn

yarn global remove @tosesh/tose

Tùy chọn, xóa cấu hình:

rm -rf ~/.tose

Khắc phục sự cố

Lệnh không tìm thấy

Nếu bạn nhận được tose: command not found sau khi cài đặt toàn cục:

Trên macOS/Linux:

1. Kiểm tra đường dẫn npm global bin:

   npm config get prefix

2. Thêm vào PATH trong ~/.bashrc hoặc ~/.zshrc:

   export PATH="$PATH:$(npm config get prefix)/bin"

3. Tải lại shell:

   source ~/.bashrc  # hoặc ~/.zshrc

Trên Windows:

1. Kiểm tra đường dẫn npm global:

   npm config get prefix

2. Thêm đường dẫn vào biến môi trường PATH của hệ thống

Lỗi quyền

Nếu gặp lỗi quyền trên macOS/Linux:

sudo npm install -g @tosesh/tose

Hoặc cấu hình npm để sử dụng thư mục khác:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Vấn đề mạng

Nếu cài đặt thất bại do vấn đề mạng:

1. Thử sử dụng registry npm khác:

   npm install -g @tosesh/tose --registry=https://registry.npmjs.org/

2. Kiểm tra cài đặt proxy:

   npm config get proxy
   npm config get https-proxy

Module không tìm thấy

Nếu gặp lỗi module sau khi cài đặt:

# Xóa cache npm
npm cache clean --force

# Cài đặt lại
npm install -g @tosesh/tose

Tiếp theo

Bây giờ TOSE CLI đã được cài đặt:

1. Bắt đầu - Triển khai ứng dụng đầu tiên
2. Tổng quan lệnh - Tìm hiểu về các lệnh có sẵn
3. Cấu hình - Cấu hình TOSE CLI

Hỗ trợ

Gặp vấn đề với cài đặt?

• Kiểm tra GitHub Issues
• Email: tobi@wearetopgroup.com