インストールとサインイン

Lockpick CLIを使うと、あなたとコーディングアシスタントは、ターミナルからLockpickを利用できます。Node.js 20.9 以降が必要です。

インストール

npm install -g lockpicks

パッケージ名は lockpicks で、末尾に s が付きます。インストールされるコマンドは lockpick です。インストールせずに、npx lockpicks で実行することもできます。

サインイン

lockpick login --host https://www.lockpick.app

スニペットでは、--host でこのLockpickサーバーを指定しています。組み込みの既定のホストはありません。CLIは --host、次に LOCKPICK_HOST、次に保存されたプロファイルの順に値を使います。最初のサインインの後は、lockpick login で同じプロファイルを再利用できます。

ブラウザーが開き、サインインの承認を求められます。キーはターミナルに直接届くため、手でコピーする必要はありません。

既定では、キーはサイトとレポートを読むことだけができます。サインインするときに、さらに必要な権限を選べます。

• --pulse を指定すると、Pulseスキャン、クイックチェック、無料の「このレコードを再読み込み」を開始できます。
• --sites を指定すると、サイトの追加、無料枠のサイトの切り替え、パッケージのバージョンのMonitorへの送信ができます。
• --deep を指定すると、Deepスキャンを準備できます。実行の承認はLockpickで行います。
• --no-browser を指定すると、ブラウザーを開く代わりにサインイン用のアドレスを表示します。

lockpick whoami で、どのアカウントでサインインしているか確認できます。lockpick logout でサインアウトします。サインアウトすると、キーも取り消されます。

最初のコマンド

lockpick whoami
lockpick sites
lockpick status

これらのコマンドは、アカウントと既存の結果を読むだけで、スキャンは開始しません。接続がうまくいかないときは、lockpick doctor を実行してください。

チェックを開始するには、--pulse 付きでサインインし、お持ちのサイトか、テストを許可されたサイトを使います。atlas.example はアドレスの例であり、実際のテスト対象ではありません。スキャンを開始すると、Lockpickに表示される利用枠が使われます。スキャンの状態やレポートを読んでも、別のスキャンは使われません。

すべてのコマンドは、スクリプト用の --json と、オプションを表示する --help に対応しています。コマンドで一覧を確認できます。

終了コード

エラーの末尾には、そのエラーを説明するページへのリンクが付きます。lockpick doctor で設定を確認できます。lockpick docs <words> を使うと、ターミナルからこれらのドキュメントを検索できます。