跳到主要内容

Logto CLI

Logto CLI 为你提供了一种便捷的方式，无需手动处理那些繁琐的技术细节，即可安装、维护和更新你的 Logto 实例。

备注:

目前我们不提供二进制文件，因此环境中需要 Node.js ^18.12.0。

全局安装 CLI​

通过你喜欢的包管理器全局安装，以便使用 logto 命令：

npm i @logto/cli -g

你可以随时在每个命令后添加 --help，以显示该命令的帮助信息：

logto --help
logto db seed --help

本地 CLI​

自 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

离线或隔离环境部署的种子数据​

自 Logto v1.40.0 起，init（安装）和 db seed 命令都支持一个额外的参数，用于在安装过程中无法访问公网的环境：

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

启用后，admin tenant 的种子密码策略默认禁用 Have I Been Pwned (HIBP) 泄露检测。这意味着在 Welcome 页面创建初始管理员时，如果无法访问 api.pwnedpasswords.com（例如在隔离数据中心或严格的出口防火墙环境下），流程不会卡住。

该参数仅作用于 admin tenant。默认 tenant 的密码策略不会被更改，首次管理员登录后，你可以通过 Admin Console > 登录体验 > 密码策略 自行管理。

一键安装（推荐用于全新 OSS 部署）：

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

为已有数据库种子数据（Logto 已解压或需要重新种子时）：

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

--dapc 和 --disable-admin-pwned-password-check 是等价的，任选其一即可。