SePay CLI chạy trên macOS, Linux và Windows, với máy x64 hoặc arm64 (gồm cả Mac chip Apple). Tìm hệ điều hành của bạn trong bảng rồi chọn một cách cài:
| Hệ điều hành | Cách cài |
|---|---|
| macOS | Homebrew, script cài một dòng, npm, go install |
| Linux | Script cài một dòng, Homebrew, npm, go install |
| Windows | Script PowerShell, Scoop, npm, go install |
Dùng npm khi máy đã có Node.js, hoặc khi muốn cả nhóm dùng cùng một phiên bản trong dự án. Dùng go install khi máy đã có Go.
Chỉ cài bằng một cách. Cài hai cách thì máy có hai lệnh sepay và bạn khó biết bản nào đang chạy.
Cài trên macOS
Homebrew trên macOS
SePay phân phối CLI qua tap riêng sepayvn/sepay-cli, không có trên kho chính homebrew-core. Cài bằng tên đầy đủ, Homebrew tự thêm tap:
$ brew install sepayvn/sepay-cli/sepayHoặc thêm tap một lần, sau đó gọi gói bằng tên ngắn:
$ brew tap sepayvn/sepay-cli$ brew install sepayHomebrew cài sẵn shell completion cho Bash, Zsh và Fish.
Script cài một dòng trên macOS
Không dùng Homebrew thì cài bằng script:
$ curl -fsSL https://get.sepay.vn/sepay-cli-install.sh | shScript tải bản mới nhất cho đúng hệ điều hành và kiến trúc máy, kiểm tra mã SHA-256 rồi đặt lệnh sepay vào ~/.local/bin, không cần sudo. Tệp tải về sai mã kiểm tra thì script dừng và không cài gì.
Máy có cosign thì script kiểm thêm chữ ký của bản phát hành, và từ chối cài nếu bản đó không có chữ ký. Muốn script không bao giờ cài khi thiếu bước kiểm chữ ký, đặt SEPAY_REQUIRE_SIGNATURE=1: máy chưa có cosign thì script dừng và không cài gì.
Ba tùy chọn đổi cách cài, truyền sau sh -s --:
| Tùy chọn | Biến môi trường tương ứng | Mặc định | Dùng khi |
|---|---|---|---|
--version | SEPAY_VERSION | bản mới nhất | Cài một phiên bản cụ thể (x.x.x) |
--dir | SEPAY_INSTALL_DIR | ~/.local/bin | Đặt lệnh sepay vào thư mục khác |
--no-modify-path | SEPAY_NO_MODIFY_PATH | không đặt | Không để script sửa file khởi động của shell |
$ curl -fsSL https://get.sepay.vn/sepay-cli-install.sh | sh -s -- --version x.x.x --dir ~/binNếu thư mục cài chưa có trong PATH, script tự thêm vào cuối file khởi động của shell bạn đang dùng (theo biến $SHELL) một khối từ dòng # >>> sepay-cli PATH >>> đến dòng # <<< sepay-cli PATH <<<:
| Shell | File khởi động |
|---|---|
| zsh | ~/.zshrc, hoặc $ZDOTDIR/.zshrc nếu có đặt ZDOTDIR |
| bash trên macOS | File có trước tiên trong ~/.bash_profile, ~/.bash_login, ~/.profile; chưa có file nào thì tạo ~/.bash_profile |
| bash trên Linux | ~/.bashrc |
| fish | ~/.config/fish/conf.d/sepay.fish, hoặc $XDG_CONFIG_HOME/fish/conf.d/sepay.fish nếu có đặt XDG_CONFIG_HOME |
sh, dash, ksh, hoặc máy không có $SHELL | ~/.profile |
| Shell khác (tcsh, nushell…) | Không sửa file nào, script chỉ nhắc bạn tự thêm thư mục cài vào PATH |
Chạy lại script không ghi trùng khối này. Script không đổi được PATH của terminal đang mở: mở terminal mới, hoặc chạy dòng export PATH=... mà script in ra.
Muốn script không sửa file khởi động, truyền --no-modify-path hoặc đặt SEPAY_NO_MODIFY_PATH=1: script chỉ in dòng export PATH=... để bạn tự thêm. Biến để rỗng hoặc 0 thì script vẫn sửa; đã truyền --no-modify-path thì script không sửa, bất kể giá trị của biến. Thư mục cài là đường dẫn tương đối, hoặc có ký tự ", `, $, \, : hay xuống dòng, thì script cũng không sửa file mà chỉ nhắc bạn tự thêm.
Nếu máy đã có một lệnh sepay khác đứng trước trong PATH, script báo note: another sepay at <đường dẫn> comes first on your PATH; gỡ bản đó hoặc đưa thư mục cài lên trước trong PATH, không thì gõ sepay vẫn chạy bản cũ.
Cài trên Linux
Script cài một dòng trên Linux
$ curl -fsSL https://get.sepay.vn/sepay-cli-install.sh | shĐây là cùng script với macOS: kiểm tra mã SHA-256 và chữ ký, đặt lệnh sepay vào ~/.local/bin, không cần sudo. Thư mục cài chưa có trong PATH thì script tự thêm vào ~/.bashrc (với bash) hoặc file khởi động của shell bạn dùng. Tùy chọn --version, --dir, --no-modify-path và biến SEPAY_REQUIRE_SIGNATURE dùng như ở Script cài một dòng trên macOS.
Homebrew trên Linux
Máy Linux đã có Homebrew thì cài như trên macOS:
$ brew install sepayvn/sepay-cli/sepayCài trên Windows
Script PowerShell trên Windows
Chạy trong PowerShell (Windows PowerShell 5.1 trở lên, hoặc PowerShell 7):
$ irm https://get.sepay.vn/sepay-cli-install.ps1 | iexScript PowerShell kiểm tra giống script trên macOS và Linux: mã SHA-256, chữ ký khi máy có cosign, và SEPAY_REQUIRE_SIGNATURE=1 để không cài khi thiếu cosign. Script đặt sepay.exe vào %LOCALAPPDATA%\Programs\sepay và thêm thư mục này vào PATH của tài khoản Windows, không cần quyền admin. Mở cửa sổ PowerShell mới để dùng lệnh sepay.
Script này không nhận tham số. Đặt biến môi trường trước lệnh để đổi cách cài:
| Biến môi trường | Mặc định | Dùng khi |
|---|---|---|
SEPAY_VERSION | bản mới nhất | Cài một phiên bản cụ thể (x.x.x) |
SEPAY_INSTALL_DIR | %LOCALAPPDATA%\Programs\sepay | Đặt sepay.exe vào thư mục khác |
SEPAY_NO_MODIFY_PATH | không đặt | Đặt 1 để script không sửa PATH |
$ $env:SEPAY_VERSION = 'x.x.x'; irm https://get.sepay.vn/sepay-cli-install.ps1 | iexScoop trên Windows
Thêm bucket của SePay rồi cài:
$ scoop bucket add sepay https://github.com/sepayvn/scoop-sepay-cli$ scoop install sepay/sepayCài bằng npm hoặc Go (mọi hệ điều hành)
npm
Cần Node.js 18 trở lên, chạy được trên cả macOS, Linux và Windows:
$ npm install -g sepay-cligo install
Cần Go 1.21 trở lên. Từ bản 1.21, Go tự tải bản mới hơn khi cần nên bạn không phải nâng Go trước. Lần đầu chạy sẽ thấy dòng switching to go1.x.x và Go tải thêm vài chục MB.
$ go install github.com/sepayvn/sepay-cli/cmd/sepay@latestCài một phiên bản cụ thể thì thay @latest bằng số phiên bản, có chữ v đứng trước:
$ go install github.com/sepayvn/sepay-cli/cmd/sepay@vx.x.xGo đặt lệnh sepay vào thư mục $(go env GOBIN), hoặc $(go env GOPATH)/bin khi chưa đặt GOBIN. Với cài đặt mặc định, đó là ~/go/bin trên macOS và Linux, %USERPROFILE%\go\bin trên Windows. Trên macOS và Linux, bộ cài Go không tự thêm thư mục này vào PATH (bộ cài Windows thì có), nên cài xong mà gõ sepay báo command not found thì thêm vào ~/.zshrc (hoặc ~/.bashrc nếu dùng Bash):
$ echo 'export PATH="$(go env GOPATH)/bin:$PATH"' >> ~/.zshrc$ source ~/.zshrc$ sepay versionCài bằng go install không kèm shell completion; tự cấu hình theo mục Shell completion.
Kiểm tra cài đặt
Lệnh in số phiên bản, mã commit và ngày build. Với bản phát hành chính thức, dòng thứ hai là trang ghi chú phát hành của phiên bản đó:
$ sepay versionsepay version x.x.x (xxxxxxx, YYYY-MM-DD)https://github.com/sepayvn/sepay-cli/releases/tag/vx.x.xXác minh bản tải về
Script cài đã tự kiểm tra mã SHA-256 (và chữ ký, khi máy có cosign). Nếu bạn tải archive bằng tay từ GitHub Releases, tự kiểm tra như sau. Mỗi bản phát hành có checksums.txt, chữ ký checksums.txt.sig và chứng chỉ checksums.txt.pem; tải ba tệp này về cùng thư mục với archive rồi chạy:
cosign verify-blob checksums.txt \--signature checksums.txt.sig \--certificate checksums.txt.pem \--certificate-identity-regexp '^https://github\.com/sepayvn/sepay-cli/\.github/workflows/release\.yml@refs/(heads/main|tags/v.*)$' \--certificate-oidc-issuer https://token.actions.githubusercontent.comsha256sum -c --ignore-missing checksums.txt # macOS: shasum -a 256 -c --ignore-missing checksums.txtgh attestation verify sepay_<version>_linux_amd64.tar.gz -R sepayvn/sepay-cli
Lệnh đầu xác nhận checksums.txt do quy trình phát hành của SePay ký. Lệnh thứ hai xác nhận archive khớp với tệp đó. Lệnh cuối kiểm tra archive được build từ commit nào trong kho mã của SePay CLI.
Cài vào một dự án
Muốn cả nhóm và CI dùng cùng một phiên bản CLI, cài vào dự án bằng npm rồi gọi bằng npx sepay:
$ npm install --save-dev sepay-cliKiểm tra bản đã cài trong dự án:
$ npx sepay versionnpm ghi số phiên bản đã cài vào package.json và package-lock.json; CI cài lại đúng bản đó bằng npm ci.
Shell completion
Không bắt buộc: bấm Tab để gợi ý lệnh, flag, giá trị của flag như --env, khóa cấu hình và tên profile. Cài bằng Homebrew thì đã có sẵn cho Bash, Zsh và Fish. Cấu hình xong, mở một shell mới để áp dụng.
Bash cần gói bash-completion (apt install bash-completion hoặc brew install bash-completion). Thêm completion vào ~/.bashrc:
$ echo 'source <(sepay completion bash)' >> ~/.bashrcZsh cần bật compinit trong ~/.zshrc trước. Thêm completion vào ~/.zshrc:
$ echo 'source <(sepay completion zsh)' >> ~/.zshrcVới Fish, ghi script vào thư mục completion:
$ sepay completion fish > ~/.config/fish/completions/sepay.fishVới PowerShell, nạp completion cho phiên đang mở; thêm cùng dòng đó vào $PROFILE để mọi phiên đều có:
$ sepay completion powershell | Out-String | Invoke-ExpressionCập nhật
Từ bản 0.1.8, SePay CLI có lệnh sepay update (viết tắt sepay upgrade). Bản cũ hơn chưa có lệnh này: cập nhật bằng cách chạy lại lệnh cài, hoặc dùng lệnh cập nhật của công cụ bạn đã dùng để cài ở bảng dưới.
$ sepay updateLệnh tải bản mới nhất trên GitHub Releases cho đúng hệ điều hành và kiến trúc máy, kiểm mã SHA-256 theo tệp checksums.txt của bản đó, chạy thử bản mới rồi mới thay bản sepay đang chạy. Máy có cosign thì lệnh kiểm thêm chữ ký của checksums.txt. Đặt SEPAY_REQUIRE_SIGNATURE=1 để lệnh từ chối cập nhật khi máy chưa có cosign.
Trước khi thay, lệnh hỏi y/N. Thêm --yes để bỏ câu hỏi; chạy không có terminal (script, CI) thì bắt buộc phải có --yes.
| Lệnh | Việc làm |
|---|---|
sepay update | Cài bản mới nhất |
sepay update --check | Chỉ báo có bản mới hay không, không cài. Dùng được với mọi cách cài |
sepay update --check --json | Như trên, in JSON cho script đọc |
sepay update --version x.y.z | Cài đúng bản x.y.z |
Ví dụ sepay update --check --json trên máy cài bằng Homebrew:
{"current": "0.1.7","latest": "0.2.0","update_available": true,"channel": "homebrew","update_command": "brew upgrade sepay"}
channel là cách bạn đã cài, update_command là lệnh cập nhật hợp với cách cài đó. Máy cài bằng script, channel là standalone và update_command là sepay update.
sepay update chỉ tự thay được bản cài bằng script cài một dòng (curl hoặc PowerShell) hoặc giải nén từ file trên GitHub Releases. Cài bằng cách khác thì lệnh không thay gì: lệnh in lệnh cập nhật của công cụ đó rồi thoát với mã 1.
| Cách cài | Lệnh sepay update in ra |
|---|---|
| Homebrew | brew upgrade sepay |
| Scoop | scoop update sepay |
| npm | npm install -g sepay-cli@latest, kèm npm install -D sepay-cli@latest cho bản cài trong dự án |
| go install | go install github.com/sepayvn/sepay-cli/cmd/sepay@latest |
Với --version, cài bằng npm hoặc go install thì lệnh in lệnh cài đúng bản đó (ví dụ go install github.com/sepayvn/sepay-cli/cmd/sepay@v0.2.0). Homebrew và Scoop chỉ cài được bản mới nhất, nên lệnh báo không cài được bản bạn chọn.
Mỗi ngày một lần, CLI kiểm tra xem có bản mới không. Khi có bản chính thức mới hơn, hoặc bản bạn đang dùng bị đánh dấu ngừng hỗ trợ, CLI in một thông báo ra stderr sau mỗi lệnh chạy thành công, kèm lệnh cập nhật đúng với cách bạn đã cài. CLI không tự cài bản mới.
Thông báo chỉ hiện khi stderr là terminal, và không hiện trong CI (khi có biến CI) hay khi dùng --json, -o yaml, --quiet. Tắt hẳn bằng SEPAY_NO_UPDATE_NOTIFIER=1.
Gỡ bỏ
Gỡ bằng đúng cách bạn đã dùng để cài:
| Cách cài | Gỡ bỏ |
|---|---|
| Homebrew | brew uninstall sepay, rồi brew untap sepayvn/sepay-cli nếu không cần tap nữa |
| Scoop | scoop uninstall sepay |
| Script cài một dòng (macOS, Linux) | Xóa tệp ~/.local/bin/sepay (hoặc trong thư mục bạn đã chọn bằng --dir), và xóa khối có dấu mốc sepay-cli PATH trong file khởi động của shell (với fish là xóa file sepay.fish) |
| Script cài một dòng (Windows) | Xóa thư mục %LOCALAPPDATA%\Programs\sepay (hoặc thư mục bạn đã đặt ở SEPAY_INSTALL_DIR), rồi bỏ thư mục đó khỏi PATH |
| npm | npm uninstall -g sepay-cli |
| go install | rm "$(go env GOPATH)/bin/sepay" (hoặc tệp sepay trong GOBIN nếu bạn có đặt) |
Với bản cài trong dự án, gỡ bằng npm uninstall sepay-cli.
Go không có lệnh gỡ: xóa tệp sepay là xong. Mã nguồn Go đã tải vẫn nằm trong module cache; go clean -modcache xóa cache đó, nhưng xóa luôn thư viện của mọi dự án Go khác trên máy.
Trước khi gỡ, chạy sepay logout để xóa token. Gỡ CLI không xóa thư mục cấu hình; muốn xóa thì tìm thư mục đó theo hệ điều hành ở Môi trường và cấu hình.