Tài liệu TOSE

Triển khai và quản lý ứng dụng của bạn một cách dễ dàng.

TOSE là nền tảng triển khai cho phép bạn deploy ứng dụng từ Git repository với tự động build, tên miền riêng, biến môi trường, cơ sở dữ liệu, và nhiều hơn nữa. Sử dụng CLI hoặc API để quản lý mọi thứ.

Cài đặt

Cài đặt TOSE CLI qua npm:

npm install -g @tosesh/tose

Kiểm tra:

tose -V

Yêu cầu:

Node.js 18.0.0 trở lên
npm hoặc yarn

Xác thực

TOSE sử dụng API key để xác thực. Lấy API key từ TOSE Dashboard.

Đăng nhập với CLI

tose login

Lưu API key vào ~/.tose/config.json.

Biến môi trường

export TOSE_API_KEY=tose_sk_your_key_here

Thứ tự ưu tiên

Flag --api-key
Biến môi trường TOSE_API_KEY
File config (~/.tose/config.json)
Nhập thủ công

Bắt đầu nhanh

Deploy ứng dụng đầu tiên trong 3 bước:

1. Đăng nhập

tose login

2. Khởi tạo & Deploy

Từ thư mục dự án:

# Deploy một lệnh (tự động init + deploy)
tose up

# Hoặc từng bước:
tose init          # Liên kết thư mục với workspace/project
tose deploy        # Triển khai project

3. Theo dõi

# Xem trạng thái
tose status

# Xem logs trực tiếp
tose logs -f

# Mở trên trình duyệt
tose open

Workspaces

Workspace là đơn vị tổ chức chứa projects, databases, và templates. Mỗi workspace có billing, thành viên, và tài nguyên riêng.

# Đặt workspace
tose use my-workspace

# Hoặc dùng biến môi trường
export TOSE_WORKSPACE=my-workspace

# Hoặc tạo .tose.json
tose init

Projects

Project là ứng dụng có thể triển khai, kết nối với Git repository.

# Tạo và deploy
tose up

# Quản lý
tose status           # Xem trạng thái & pods
tose restart          # Khởi động lại pods
tose down             # Dừng triển khai

Triển khai

Mỗi lần deploy tạo một deployment mới với build logs, Docker image, và tài nguyên K8s.

# Deploy
tose deploy

# Redeploy (không build lại)
tose redeploy

# Xem build logs
tose logs --build

# Stream logs trực tiếp
tose logs -f

Biến môi trường

# Đặt biến
tose env set DATABASE_URL=postgres://... API_KEY=secret

# Liệt kê
tose env list

# Xóa
tose env rm DATABASE_URL

# Upload file .env
tose env push .env

# Tải về file
tose env pull .env.local

Tên miền riêng

# Thêm tên miền
tose domain add example.com

# Liệt kê
tose domain list

# Xóa
tose domain rm example.com

Sau khi thêm, cấu hình DNS bằng cách trỏ CNAME đến tên miền mặc định của project.

Cơ sở dữ liệu

Tạo database được quản lý trực tiếp từ CLI.

# Tạo (tương tác)
tose db create

# Liệt kê
tose db list

# Xem thông tin kết nối
tose db info my-postgres

Hỗ trợ: postgresql, mysql, redis, mongodb

Templates

Templates là ứng dụng được xây dựng sẵn, có thể triển khai bằng một lệnh duy nhất.

# Xem templates có sẵn
tose template catalog

# Tạo và deploy (tất cả trong một)
tose template create "My App"
# Tự động hỏi env vars, sau đó deploy

# Hoặc từng bước:
tose template create "My App"
tose template env set my-app KEY1=value1 KEY2=value2
tose template deploy my-app

# Quản lý
tose template list             # Liệt kê templates
tose template info my-app      # Xem chi tiết
tose template logs my-app -f   # Stream logs
tose template stop my-app      # Dừng
tose template delete my-app    # Xóa