Vnstock Logo

Toàn bộ lệnh

Thử nghiệm

Mục lục

Bản thử nghiệm, chưa phát hành chính thức

Trang này viết cho vnstock_pipeline v6.0.0rc1, bản thử nghiệm. Tên hàm, tham số và cột dữ liệu có thể còn đổi trước ngày phát hành; khi cài, ghi rõ số phiên bản như ở trang Cài đặt. Bản đang phát hành chính thức là v3.1.1, xem tài liệu bản đó.

Shell
vnstock-pipeline [--config TỆP] [--base THƯ_MỤC] [--debug] <nhóm> <lệnh> [tham số]
Tham số chungÝ nghĩa
--configTệp pipeline.toml khác mặc định ~/.vnstock/config/pipeline.toml
--baseThư mục gốc cho lần chạy này, ghi đè base_path
--debugGhi nhật ký chi tiết; lỗi của nguồn in kèm chi tiết kỹ thuật
--versionPhiên bản đang cài

Đầu ra cho script và trợ lý AI

  • Mọi lệnh in JSON ra đầu ra chuẩn, trừ store tree, head, tail, stats in bảng cho người đọc.
  • Lời nhắc, cảnh báo, dòng nhắc cập nhật in ra đầu ra lỗi, nên không lẫn vào JSON.
  • Mã thoát:
    • 0: thành công;
    • 1: có đơn vị việc lỗi hoặc bị cách ly (lệnh run), lỗi quyền (PIPELINE_…, VNSTOCK_…), hoặc lỗi do nguồn trả về;
    • 2: sai cú pháp lệnh.
  • Lỗi in một dòng: Lỗi [MÃ]: nội dung và cách sửa.

Ví dụ trong script:

Shell
vnstock-pipeline run ohlcv --group VN30 > ket-qua.json || echo "cần xem lại" >&2
jq '.summary.errors' ket-qua.json

account

LệnhTham sốViệc
account login--key-env TÊN_BIẾN (mặc định VNSTOCK_API_KEY)Đăng nhập tài khoản Vnstock, đăng ký thiết bị
account logoutXoá khoá, phiên, quyền đã lưu
account statusCấp quyền, quyền dùng, thiết bị, thời hạn bản phát hành
account policyChính sách quyền và chính sách máy khách
account telemetrystatus | on | offĐo lượt dùng

config

LệnhTham sốViệc
config init--force, --baseTạo pipeline.toml mẫu
config showCấu hình đang có hiệu lực

store

LệnhTham sốViệc
store initTạo thư mục gốc và mục lục
store tree--depth (mặc định 4)Cây thư mục
store reportSố tệp, dung lượng, số dòng từng bộ dữ liệu
store catalog[bộ dữ liệu], --rebuildXem hoặc dựng lại mục lục
store audit--interval (mặc định 1D), --stale-days (mặc định 5)Kiểm nến đã lưu
store compact--dateGộp tệp phần stream; mặc định mọi ngày trước hôm nay

run

Mọi lệnh run nhận nhóm tham số chọn mã: --symbols, --group, --watchlist, --top, --source, --asset, --strict, --verbose (Tác vụ nạp dữ liệu).

LệnhTham số riêngBộ dữ liệu ghi
run ohlcv--interval (mặc định 1D), --start, --end, --mode daily|init|full, --include-todayohlcv
run trades--dates (mặc định phiên gần nhất)trades
run quote--kinds (mặc định quote,order_book)quote, order_book
run index--symbols là mã chỉ sốindex_quote
run foreign--start, --end, --modeforeign_flow
run session-stats--start, --end, --modesession_stats
run block-tradesblock_trades
run reference--parts equity_list,index_members,price_limits,trading_days,events_calendarcác bộ tham chiếu
run company--parts info,shareholders,ownership,insider_trading,all (mặc định info)company_*

universe

LệnhTham sốViệc
universe build-liquidity--days (mặc định 20), --top (mặc định 300)Xếp hạng thanh khoản trên nến ngày đã lưu
universe shownhóm tham số chọn mãIn danh sách mã của một lựa chọn

Tra cứu tệp

LệnhTham sốViệc
inspect<tệp>Tổng quan một tệp (JSON)
head, tail<tệp>, --rowsDòng đầu, dòng cuối
stats<tệp>Thống kê cột
schema file<tệp>Cột và nguồn gốc của một tệp
schema show<bộ dữ liệu>Cấu trúc chuẩn
schema reset<bộ dữ liệu>Xoá cấu trúc chuẩn

quarantine

LệnhTham sốViệc
quarantine list[bộ dữ liệu]Tệp đang cách ly, kèm khác biệt cấu trúc
quarantine adopt<tệp>Nhận cấu trúc mới làm chuẩn, xoá tệp cách ly
quarantine discard<tệp>Bỏ tệp cách ly

export

LệnhTham sốViệc
export csv|parquet|excel|amibroker--dataset (mặc định ohlcv), --symbols, --interval, --start, --end, --out, --kinds (AmiBroker: ohlcv,index,foreign)Xuất dữ liệu đã lưu

stream

LệnhTham sốViệc
stream channels<nguồn>Kênh khai sẵn của nguồn
stream run<nguồn> <kênh…>, --symbols, --seconds, --intervals (mặc định 1m), --engine auto|rust|python, --keep-rawNối, giải mã, dựng nến, ghi
stream record<nguồn> <kênh…>, --symbols, --seconds (bắt buộc), -o/--output (bắt buộc)Chỉ ghi thông điệp ra tệp JSON Lines
stream replay<tệp>, --source, --intervals, --engineChạy tệp đã ghi vào thư mục lưu trữ

migrate-legacy

LệnhTham sốViệc
migrate-legacy<thư mục gốc bản 3.x>, --dry-runChuyển dữ liệu bản 3.x sang bố cục mới, không xoá tệp cũ

Lệnh nào cần quyền

run …, stream run, stream record cần đăng nhập tài khoản thuộc gói quyền sử dụng từ cấp Golden trở lên. Mọi lệnh khác chạy được khi không có mạng.