跳至主要內容

Logto CLI

Logto CLI 提供一種方便的方式，讓你安裝、維護與更新 Logto 實例，無需手動處理那些繁瑣的技術細節。

備註:

目前我們尚未提供二進位檔，因此環境中需安裝 Node.js ^22.14.0。

全域安裝 CLI​

透過你偏好的套件管理工具全域安裝，便可使用 logto 指令：

npm i @logto/cli -g

你隨時可以加上 --help 來顯示每個指令的說明資訊：

logto --help
logto db seed --help

本地 CLI​

自 Logto v1.0.0-beta.11 起，每個 Logto 版本都內建一份 CLI。假設你已在 ~/logto 擁有一個 Logto 實例，可以執行下列指令：

cd ~/logto
npm run cli # 執行本地 CLI

注意：若要帶入選項，需在 Logto CLI 的選項前加上 --，例如：

npm run cli db seed -- --db-url postgresql://your-database-url

透過 npx 使用 CLI​

另一種使用 Logto CLI 的方式是 npx，可直接執行套件而無需安裝。

npx @logto/cli

這對於一次性操作特別有用，例如：

npx @logto/cli db seed --db-url postgresql://your-database-url

空中隔離或離線部署的資料填充（Seed）​

自 Logto v1.40.0 起，init（安裝）與 db seed 指令皆支援額外旗標，適用於安裝過程中無法連上公網的環境：

--disable-admin-pwned-password-check, --dapc

啟用後，管理租戶（admin tenant） 的預設密碼政策會停用 Have I Been Pwned (HIBP) 洩漏檢查。這代表當 api.pwnedpasswords.com 無法連線時（例如在空中隔離資料中心或嚴格出口防火牆下），從歡迎頁建立初始管理員帳號不會卡住。

此旗標僅影響管理租戶。預設租戶的密碼政策不受影響，且可於 Admin Console > 登入體驗 (Sign-in experience) > 密碼政策 (Password policy) 於首位管理員登入後自行調整。

一鍵安裝（建議用於全新 OSS 部署）：

logto init --disable-admin-pwned-password-check

填充現有資料庫（Logto 已解壓縮或需重新填充時）：

logto db seed --disable-admin-pwned-password-check

--dapc 與 --disable-admin-pwned-password-check 為同義詞，任選其一皆可。