メインコンテンツまでスキップ

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​

CLI の組み込みバージョンは、v1.0.0-beta.11 以降のすべての Logto リリースに同梱されています。たとえば、~/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

このフラグを指定すると、管理テナント のシード時のパスワードポリシーで Have I Been Pwned (HIBP) 漏洩チェックがデフォルトで無効になります。つまり、api.pwnedpasswords.com にアクセスできない場合（エアギャップデータセンターや厳格な外部通信制限下など）でも、Welcome ページから初期管理者を作成する際に処理が止まることがなくなります。

このフラグは管理テナントのみに適用されます。デフォルトテナントのパスワードポリシーは変更されず、最初の管理者サインイン後に 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 は同義です。どちらでも利用できます。