Cài Đặt CLI
(Command Line)
Hướng dẫn cài đặt bằng dòng lệnh cho máy chủ, cloud platforms không có giao diện đồ hoạ (GUI), và cho Windows.
wget hoặc curl, không cần trên Windows — xem mục Windows), và API key từ trang quản lý tài khoản.💡 Nếu cài trên Notebook (Colab, Kaggle, Codespaces), thêm dấu ! phía trước mỗi lệnh
Tải CLI installer
Trên Linux (hoặc môi trường có wget):
Trên macOS (hoặc môi trường dùng curl):
Phân quyền cho file
Chạy installer
.run là script bash nên không chạy trên Windows. Trên Windows dùng trình cài Python (từ bản 3.1.3) — cùng tham số với bản .run, không mở cửa sổ, hợp để trợ lý AI cài hộ.1. Cài trình cài
Cần Python 3.10–3.14 từ python.org (khi cài nhớ tích Add python.exe to PATH).
pip install -U --extra-index-url https://vnstocks.com/api/simple vnstock_installer==3.1.32. Chạy trình cài
Lần đầu, chạy không tham số: trình cài hỏi khoá (ký tự gõ vào không hiện ra) rồi lưu vào %USERPROFILE%\.vnstock. Những lần sau, hoặc khi đã có khoá, cài tự động:
vnstock-cli-installer
vnstock-cli-installer --non-interactivePowerShell báo không nhận ra lệnh vnstock-cli-installer (thư mục Scripts của Python chưa nằm trong PATH) thì gọi qua Python (không tham số thì lệnh này mở giao diện, nên lần đầu thêm --cli):
python -m vnstock_installer --cli
python -m vnstock_installer --non-interactive3. Kiểm tra
Cuối quá trình, trình cài in dòng Kiểm tra / Verify — chạy đúng lệnh đó. Lệnh chỉ gồm các gói thuộc gói tài trợ của bạn: Bronze có vnstock_data; Silver thêm vnstock_ta, vnstock_news; Golden và Diamond thêm vnstock_pipeline (cần Python 3.11+).
Đối chiếu lệnh macOS/Linux ↔ Windows
| Việc | macOS / Linux | Windows |
|---|---|---|
| Cài có hỏi khoá | bash vnstock-cli-installer.run | vnstock-cli-installer |
| Cài tự động | bash vnstock-cli-installer.run -- --non-interactive | vnstock-cli-installer --non-interactive |
| Chọn môi trường ảo | bash vnstock-cli-installer.run -- --non-interactive --venv-path "/opt/vnstock/.venv" | vnstock-cli-installer --non-interactive --venv-path "D:\envs\.venv" |
| Giao diện tiếng Anh | bash vnstock-cli-installer.run -- --non-interactive --language en | vnstock-cli-installer --non-interactive --language en |
Cài đặt Tự động (Non-Interactive)
Dành cho các hệ thống tự động hoá như CI/CD pipeline, GitHub Actions, Docker, hoặc máy chủ không có giao diện.
Tải, kiểm tra toàn vẹn rồi cài tự động:
# Dùng wget (Linux/WSL)
wget -q https://vnstocks.com/files/vnstock-cli-installer.run -O installer.run
# HOẶC dùng curl (macOS)
# curl -sL https://vnstocks.com/files/vnstock-cli-installer.run -o installer.run
# Kiểm tra tệp tải về không bị hỏng hay bị sửa
bash installer.run --check
# Khoá lấy từ biến VNSTOCK_API_KEY do hệ thống CI cấp từ kho bí mật,
# hoặc từ khoá đã lưu trên máy — không gõ khoá trên dòng lệnh
bash installer.run -- --non-interactiveTrên máy cá nhân, lưu khoá một lần bằng python -c "from vnstock.core.utils.auth import register_user; register_user()"; trình cài tự dùng khoá đã lưu. Trên CI (GitHub Actions, GitLab…), khai VNSTOCK_API_KEY là biến bí mật của hệ thống đó. Với tệp .run, hai dấu gạch -- trước --non-interactive là bắt buộc.
Tuỳ chỉnh nâng cao & môi trường ảo:
bash installer.run -- --non-interactive --venv-path "/opt/vnstock/.venv" --language enWindows (PowerShell) — cùng tham số, không cần dấu --:
# Khoá lấy từ %USERPROFILE%\.vnstock hoặc biến VNSTOCK_API_KEY
vnstock-cli-installer --non-interactive
vnstock-cli-installer --non-interactive --venv-path "D:\envs\.venv" --language enTrên GitHub Actions dùng runner windows-latest: cài trình cài bằng pip ở bước trước, khai VNSTOCK_API_KEY là biến bí mật, rồi chạy lệnh trên. Thêm --json nếu cần đọc kết quả bằng máy.
vnstock-cli-installer.run (macOS/Linux) và vnstock-cli-installer (Windows).| Tùy chọn CLI | Biến Môi trường | Ý nghĩa |
|---|---|---|
| --api-key | VNSTOCK_API_KEY | API key của tài khoản. Nên dùng biến môi trường hoặc khoá đã lưu: khoá ghi thẳng sau --api-key sẽ nằm lại trong lịch sử dòng lệnh |
| --non-interactive | — | Tắt tất cả hộp thoại prompt chờ nhập dữ liệu. Tự bật khi không có terminal (CI, Docker, chạy qua pipe) |
| --venv-path | VNSTOCK_VENV_PATH | Chỉ định cụ thể đường dẫn tạo môi trường ảo Python |
| --language | — | Ngôn ngữ: vi (mặc định) hoặc en. Viết tắt --lang |
| --verbose | — | In log chi tiết để gỡ lỗi |
| --packages --list-packages --json | — | Chỉ có ở trình cài Python (Windows): chọn gói cần cài (vnstock_data,vnstock_ta), xem gói tài khoản được cài, in kết quả dạng JSON cho trợ lý AI |
Hãy chắc chắn bạn đang dùng vnstock installer CLI v3.0.2 trở lên được cập nhật từ 12/5/2026. Phiên bản này tự động phát hiện và cảnh báo nếu bạn lỡ chọn đường dẫn venv trùng với thư mục dự án, giúp bảo vệ mã nguồn khỏi nguy cơ bị ghi đè.
Khuyến nghị: Trừ phi bạn hiểu rõ về hệ thống, hãy giữ nguyên đường dẫn cài đặt mặc định (vd: ~/.venv) để trình cài tự động thiết lập cấu hình tối ưu và an toàn nhất.
Cần Hỗ Trợ?
Nếu gặp vấn đề, hãy liên hệ cộng đồng Sponsor hoặc quay lại trang chính.