Logto CLI

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

備註:

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

全域安裝 CLI

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

npm

npm i @logto/cli -g

Yarn

yarn global add @logto/cli

pnpm

pnpm add -g @logto/cli

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

logto --help
logto db seed --help

本地 CLI

自 Logto v1.0.0-beta.11 起，每個版本都內建 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

適用於隔離或離線部署的種子資料

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

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

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

此旗標僅作用於管理租戶。預設租戶的密碼政策不受影響，首次管理員登入後，你可於管理主控台 > 登入體驗 (Sign-in experience) > 密碼政策 (Password policy) 自行調整。

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

CLI

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

npm

npm init @logto@latest -- --disable-admin-pwned-password-check

npx

npx @logto/cli init --disable-admin-pwned-password-check

為現有資料庫種子（Logto 已解壓或需重新種子時）：

CLI

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

npm

npm run cli db seed -- --disable-admin-pwned-password-check

npx

npx @logto/cli db seed --disable-admin-pwned-password-check

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