# コマンド

lockpickのすべてのコマンドとそのオプションです。CLI自身から自動生成しています。

{/* Generated by scripts/docs-generate.mts. Do not edit; run `pnpm docs:generate`. */}

ターミナルからLockpickを使えます。クイックチェック、サイト、状態、検出事項、修正ブリーフ、Pulseスキャン、承認して実行するDeepスキャン、再チェックを、あなたとコーディングエージェントのために行えます。

ターミナルで `lockpick <command> --help` を実行すると、同じオプションが表示されます。すべてのコマンドは `--host` と `--json` も受け付けます。

## lockpick login

ブラウザーでサインインし、1つのワークスペース用のキーを保存します

```bash title="使い方"
lockpick login [options]
```

| 引数             | 役割                                                           |
| -------------- | ------------------------------------------------------------ |
| `--no-browser` | ブラウザーを開かずに、サインイン用のリンクを表示します                                  |
| `--pulse`      | Pulseスキャン、クイックチェック、無料のDNSの再チェックを開始する権限を求めます（ブラウザーでチェックを入れます） |
| `--sites`      | サイトの追加と、無料枠のサイトの切り替えの権限を求めます（ブラウザーでチェックを入れます）                |
| `--deep`       | Lockpickで承認するDeepスキャンを準備する権限を求めます（ブラウザーでチェックを入れます）           |
| `--local`      | ローカル評価の権限を要求                                                 |

## lockpick logout

このターミナルのキーを取り消して、保存したキーを削除します

```bash title="使い方"
lockpick logout
```

## lockpick whoami

このターミナルが使っているユーザー、ワークスペース、キーを表示します

```bash title="使い方"
lockpick whoami
```

## lockpick doctor

スキャンを開始せずに、CLI、アドレス、接続、認証、ワークスペースへのアクセスを確認します

```bash title="使い方"
lockpick doctor [options]
```

| 引数                | 役割                              |
| ----------------- | ------------------------------- |
| `--scope <value>` | 確認するスコープ：pulse、sites、deep、local |

## lockpick projects

プロジェクトを、それぞれの最新のPulseとDeepスキャンとともに一覧表示します

```bash title="使い方"
lockpick projects
```

## lockpick status

プロジェクトの状態レポートです。引数を省略すると、すべてのプロジェクトの概要を表示します

```bash title="使い方"
lockpick status [project]
```

| 引数          | 役割             |
| ----------- | -------------- |
| `<project>` | プロジェクトのIDまたは名前 |

## lockpick sites

サイトを一覧表示します。`lockpick sites add \<url\>` でサイトを1つ追加するか、`lockpick sites switch \<siteId\> --yes` で無料のPulseを移動できます

```bash title="使い方"
lockpick sites
```

## lockpick sites add

お持ちのサイト、またはテストを許可されたサイトを追加します（サイトを追加できるキーが必要です）。追加してもスキャンは開始されません。

```bash title="使い方"
lockpick sites add <url> [options]
```

| 引数               | 役割                                                           |
| ---------------- | ------------------------------------------------------------ |
| `<url>`          | サイトのアドレス（例: [https://atlas.example）](https://atlas.example）) |
| `--name <value>` | Lockpickに表示される名前                                             |

## lockpick sites switch

今月の無料Pulseを持っているサイトを削除して、別のサイトがそれを使えるようにします（サイトを追加し、Pulseを開始できるキーが必要です）。`--check` を付けると、そのクイックチェックのサイトでPulseも開始します。無料のPulseを1回使います。

```bash title="使い方"
lockpick sites switch <site> [options]
```

| 引数                | 役割                                       |
| ----------------- | ---------------------------------------- |
| `<site>`          | 削除するサイトのID（`lockpick sites` で確認できます）     |
| `--check <value>` | 新しいサイトのクイックチェックID。そのPulseは切り替えと同時に開始されます |
| `--yes`           | 削除を確定します。サイトは監視されなくなりますが、Lockpickで復元できます |

## lockpick runs

PulseとDeepのスキャンを、新しい順に一覧表示します

```bash title="使い方"
lockpick runs [options]
```

| 引数                  | 役割                                                                                |
| ------------------- | --------------------------------------------------------------------------------- |
| `--project <value>` | プロジェクトのIDまたは名前                                                                    |
| `--kind <value>`    | pulse \| box                                                                      |
| `--status <value>`  | queued \| running \| cancelling \| succeeded \| incomplete \| failed \| cancelled |
| `--limit <value>`   | 表示する件数（既定は20、最大100）                                                               |

## lockpick run

1つのランを表示します

```bash title="使い方"
lockpick run <runId>
```

| 引数        | 役割    |
| --------- | ----- |
| `<runId>` | ランのID |

## lockpick watch

ランが終わるまで追跡します。成功しなかった場合は終了コード3で終わります

```bash title="使い方"
lockpick watch <runId> [options]
```

| 引数                   | 役割                                                               |
| -------------------- | ---------------------------------------------------------------- |
| `<runId>`            | ランのID                                                            |
| `--fail-on <value>`  | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用） |
| `--interval <value>` | 確認の間隔（秒）。既定は5で、30まで間隔が延びます                                       |
| `--timeout <value>`  | 待つ最大時間（秒）。既定は600、最大は3600です                                       |

## lockpick pulse

プロジェクトでPulseスキャンを開始し、結果を待ちます（Pulseを開始できるキーが必要です）

```bash title="使い方"
lockpick pulse <project> [options]
```

| 引数                   | 役割                                                                                               |
| -------------------- | ------------------------------------------------------------------------------------------------ |
| `<project>`          | プロジェクトのIDまたは名前                                                                                   |
| `--no-wait`          | 結果を待たず、スキャンが開始されたら戻ります                                                                           |
| `--interval <value>` | 待っている間の確認の間隔（秒）。既定は5です                                                                           |
| `--timeout <value>`  | 待つ最大時間（秒）。既定は600、最大は3600です                                                                       |
| `--fail-on <value>`  | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用）                                 |
| `--lockfile`         | このフォルダーのパッケージ名とバージョンを、この実行で送ります（`--no-lockfile` を付けると、決して送りません）。指定しない場合、Lockpickはフォルダーごとに一度確認します |

## lockpick recheck

サイトの完全な再チェックです。Pulseスキャンを1回使う新しいPulseを実行します。`--dns \<findingId\>` を付けると、スキャンの検出事項1件について、DNSを無料で再チェックします。評価は変わりません。

```bash title="使い方"
lockpick recheck <target> [options]
```

| 引数                   | 役割                                                                                               |
| -------------------- | ------------------------------------------------------------------------------------------------ |
| `<target>`           | サイトのIDまたは名前。`--dns` を付けると、スキャンのID                                                                |
| `--dns <value>`      | 公開DNSレコードから無料で再チェックする検出事項のID（サイトには一切アクセスしません）                                                    |
| `--no-wait`          | 結果を待たず、スキャンが開始されたら戻ります                                                                           |
| `--interval <value>` | 待っている間の確認の間隔（秒）。既定は5です                                                                           |
| `--timeout <value>`  | 待つ最大時間（秒）。既定は600、最大は3600です                                                                       |
| `--fail-on <value>`  | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用）                                 |
| `--lockfile`         | このフォルダーのパッケージ名とバージョンを、この実行で送ります（`--no-lockfile` を付けると、決して送りません）。指定しない場合、Lockpickはフォルダーごとに一度確認します |

## lockpick deps

このプロジェクトのパッケージ名と正確なバージョンを、サイトに送ります（コードは送りません）。それらに影響するセキュリティアドバイザリを一覧表示します。読み取るのは package-lock.json、npm-shrinkwrap.json、pnpm-lock.yaml、yarn.lock、requirements.txt、poetry.lock です（サイトを管理できるキーが必要です）。

```bash title="使い方"
lockpick deps <site> [options]
```

| 引数                       | 役割                                                                            |
| ------------------------ | ----------------------------------------------------------------------------- |
| `<site>`                 | サイトのIDまたは名前                                                                   |
| `--path <value>`         | ロックファイルがあるプロジェクトのフォルダー（既定: このフォルダー）                                           |
| `--completeness <value>` | complete、partial、unknown（既定は unknown。すべてのインベントリを確実に含む場合のみ complete と宣言してください） |
| `--revision <value>`     | 任意のソースのリビジョン。デプロイされたことを証明するものではありません                                          |
| `--environment <value>`  | production、staging、development、unknown                                        |
| `--dry-run`              | 送られる内容を表示するだけで、送信しません                                                         |
| `--forget`               | Lockpickに保存されているサイトのパッケージ一覧を削除します                                             |

## lockpick monitor

現在のセキュリティアドバイザリと、読み取りを許可されたサイトとの一致を閲覧します。

```bash title="使い方"
lockpick monitor [options]
```

| 引数                    | 役割                                   |
| --------------------- | ------------------------------------ |
| `--site <value>`      | サイトのIDまたは名前で絞り込みます                   |
| `--query <value>`     | アドバイザリのID、タイトル、パッケージ名を検索します          |
| `--ecosystem <value>` | all、npm、pypi、composer、wordpress      |
| `--kind <value>`      | all、vulnerability、malicious_package  |
| `--view <value>`      | latest、sites、exploited、following     |
| `--severity <value>`  | all、critical、high、medium、low、unknown |
| `--days <value>`      | 7、30、90、365。0 を指定するとすべての履歴           |
| `--cursor <value>`    | 前の応答からの次のカーソル                        |
| `--advisory <value>`  | 1つのアドバイザリのIDを読みます                    |

## lockpick check

ウェブサイトの無料クイックチェック（トップページと公開DNS）、またはインストール前の公開 GitHub リポジトリのチェック（スキル、プラグイン、MCP サーバー、アプリ）。Pulseを開始できるキーが必要です。

```bash title="使い方"
lockpick check <url> [options]
```

| 引数                  | 役割                                                                                                                   |
| ------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `<url>`             | ウェブサイトのアドレス（atlas.example）または GitHub リポジトリ（github.com/owner/repo、owner/repo）                                         |
| `--no-wait`         | 結果を待たず、スキャンが開始されたら戻ります                                                                                               |
| `--timeout <value>` | 待つ最大時間（秒）。既定は90、最大は3600です                                                                                            |
| `--deep`            | GitHub リポジトリ向け: Deep リポジトリチェック。すべてのロックファイルと直近 50 件のコミットも漏えいしたキーがないか読み、より強いレビューを行います。Deep プランが必要で、Deep スキャンを 1 回使います。 |

## lockpick verify

サイトの所有を1回証明します。サイトの値と、それを公開する場所を表示します。`--wait` を付けると、その値を探し続けます（Deepスキャンを準備できるキーが必要です）

```bash title="使い方"
lockpick verify <site> [options]
```

| 引数                 | 役割                                                 |
| ------------------ | -------------------------------------------------- |
| `<site>`           | サイトのIDまたは名前                                        |
| `--method <value>` | dns（既定）、file、meta（トップページのheadにあるタグ）。既定値は `dns` です。 |
| `--wait`           | 約5分間、証明を探し続けます（証明の確認を使います）                         |

## lockpick deep local

プロジェクトの承認後に決定論的なローカルリポジトリ検査を実行

```bash title="使い方"
lockpick deep local <path> [options]
```

| 引数                            | 役割                                                               |
| ----------------------------- | ---------------------------------------------------------------- |
| `<path>`                      | リポジトリの物理パス（pwd -P）。ルートのシンボリックリンクは不可                              |
| `--project <value>`           | プロジェクト ID または一意の名前                                               |
| `--browser-artifacts <value>` | リポジトリからの相対パスで指定するブラウザー成果物ディレクトリ。複数指定可                            |
| `--env-file <value>`          | リポジトリからの相対パスで明示する環境ファイル。複数指定可                                    |
| `--dockerfile <value>`        | リポジトリからの相対 Dockerfile パス。複数指定可能                                  |
| `--migration-file <value>`    | リポジトリからの相対 SQL マイグレーションファイル。実行順に指定                               |
| `--build-context <value>`     | リポジトリからの相対ビルドコンテキスト。--dockerfile と同じ順序で指定（ルートは .）                |
| `--checks <value>`            | 検査 ID のカンマ区切りリスト。要求された未対応の検査は未完了のままです                            |
| `--history`                   | 範囲を限定した Git 履歴検査を含める                                             |
| `--source-maps`               | 指定されたブラウザーのソースマップに埋め込まれたソースを検査                                   |
| `--fail-on <value>`           | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用） |

## lockpick deep verify

Deepスキャンのための所有証明を開始します。公開するDNS TXTレコード、ファイル、またはトップページのmetaタグを用意します（Deepスキャンを準備できるキーが必要です）

```bash title="使い方"
lockpick deep verify <site> [options]
```

| 引数                 | 役割                                                 |
| ------------------ | -------------------------------------------------- |
| `<site>`           | サイトのIDまたは名前                                        |
| `--method <value>` | dns（既定）、file、meta（トップページのheadにあるタグ）。既定値は `dns` です。 |
| `--wait`           | 約5分間、証明を探し続けます（証明の確認を使います）                         |

## lockpick deep check

公開された所有証明を1回確認します（確認するたびに、証明の試行回数を1回使います）

```bash title="使い方"
lockpick deep check <site> <verificationId>
```

| 引数                 | 役割                           |
| ------------------ | ---------------------------- |
| `<site>`           | サイトのIDまたは名前                  |
| `<verificationId>` | `lockpick deep verify` で得たID |

## lockpick deep prepare

確認済みの証明でDeepスキャンを準備し、その承認ページを開きます。Lockpickで承認するまで、何も開始されません

```bash title="使い方"
lockpick deep prepare <site> <verificationId> [options]
```

| 引数                 | 役割                       |
| ------------------ | ------------------------ |
| `<site>`           | サイトのIDまたは名前              |
| `<verificationId>` | 確認済みの証明のID               |
| `--no-browser`     | ブラウザーを開かずに、承認用のリンクを表示します |

## lockpick deep start

Lockpickで承認したDeepスキャンを開始し、その完了を待ちます（準備したときに示された利用枠から、Deepスキャンを1回使います）

```bash title="使い方"
lockpick deep start <operationId> [options]
```

| 引数                   | 役割                                                               |
| -------------------- | ---------------------------------------------------------------- |
| `<operationId>`      | `lockpick deep prepare` で得たID                                    |
| `--no-wait`          | 結果を待たず、スキャンが開始されたら戻ります                                           |
| `--interval <value>` | 待っている間の確認の間隔（秒）。既定は5です                                           |
| `--timeout <value>`  | 待つ最大時間（秒）。既定は600、最大は3600です                                       |
| `--fail-on <value>`  | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用） |

## lockpick findings

ランのうち、対応が必要な検出事項です

```bash title="使い方"
lockpick findings <runId> [options]
```

| 引数                   | 役割                                                               |
| -------------------- | ---------------------------------------------------------------- |
| `<runId>`            | ランのID                                                            |
| `--severity <value>` | critical \| high \| medium \| low \| info                        |
| `--all`              | 合格した項目と、確認されなかった項目も含めます                                          |
| `--fail-on <value>`  | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用） |

## lockpick report

既存の評価と、その秘匿された検出事項を、MarkdownまたはJSONで書き出します

```bash title="使い方"
lockpick report <runId> [options]
```

| 引数              | 役割                                |
| --------------- | --------------------------------- |
| `<runId>`       | ランのID                             |
| `--out <value>` | 新しいレポートファイルを作成します。既存のファイルは上書きしません |

## lockpick finding

1つの検出事項を、その証拠とともに表示します

```bash title="使い方"
lockpick finding <runId> <findingId>
```

| 引数            | 役割               |
| ------------- | ---------------- |
| `<runId>`     | ランのID            |
| `<findingId>` | 検出事項のIDまたはLP-コード |

## lockpick brief

ランのうち、対応が必要なすべての検出事項を直すMarkdownのブリーフです。1件の検出事項だけを指定することもできます

```bash title="使い方"
lockpick brief <runId> [options]
```

| 引数                  | 役割                                                                                |
| ------------------- | --------------------------------------------------------------------------------- |
| `<runId>`           | ランのID                                                                             |
| `--finding <value>` | この検出事項だけを対象にします                                                                   |
| `--agent <value>`   | このエージェント向けに調整します: claude-code、codex、cursor、vscode、opencode、lovable、bolt、replit、v0 |
| `--out <value>`     | Markdownを書き込むファイル                                                                 |

## lockpick fix

すべてを直すブリーフを lockpick-fixes.md に保存し、そのブリーフをエージェントに渡して開始するコマンドを表示します

```bash title="使い方"
lockpick fix <runId> [options]
```

| 引数                | 役割                                                                                |
| ----------------- | --------------------------------------------------------------------------------- |
| `<runId>`         | ランのID                                                                             |
| `--agent <value>` | このエージェント向けに調整します: claude-code、codex、cursor、vscode、opencode、lovable、bolt、replit、v0 |
| `--out <value>`   | ブリーフを保存する場所（既定: lockpick-fixes.md）                                                |

## lockpick compare

再チェックのPulseを、その基準となるPulseと比べます

```bash title="使い方"
lockpick compare <runId>
```

| 引数        | 役割          |
| --------- | ----------- |
| `<runId>` | 再チェックのランのID |

## lockpick import

Codex Securityのfindings.jsonまたはSARIFファイルを読み込み、あなたのマシン上でランと関連付けます

```bash title="使い方"
lockpick import <file> [options]
```

| 引数              | 役割                                                 |
| --------------- | -------------------------------------------------- |
| `<file>`        | findings.json、またはSARIF 2.1.0ファイルのパス                |
| `--run <value>` | このランのIDと関連付けます（省略すると、ファイルを読むだけです）                  |
| `--upload`      | 共有するための最小限の関連付けキー（ルートのパス、ルールID、重大度）を作成します。既定ではオフです |

## lockpick open

ランまたはプロジェクトをブラウザーで開きます

```bash title="使い方"
lockpick open <id>
```

| 引数     | 役割                         |
| ------ | -------------------------- |
| `<id>` | ランのID、プロジェクトのID、またはプロジェクト名 |

## lockpick mcp

コーディングエージェント向けに、標準入出力でMCPサーバーを起動します

```bash title="使い方"
lockpick mcp [options]
```

| 引数                     | 役割                               |
| ---------------------- | -------------------------------- |
| `--local-root <value>` | MCP のローカルスキャンを許可する絶対ルートパス。複数指定可能 |

## lockpick mcp config

claude、cursor、vscode、codex のMCP設定を表示します

```bash title="使い方"
lockpick mcp config <client> [options]
```

| 引数                     | 役割                                              |
| ---------------------- | ----------------------------------------------- |
| `<client>`             | claude \| cursor \| vscode \| codex             |
| `--local-root <value>` | MCP のローカルスキャンを許可する絶対ルートパス。複数指定可能                |
| `--hosted`             | ローカルの標準入出力サーバーの代わりに、ホスト型のOAuthコネクターを使います        |
| `--apply`              | Cursor、VS Code、Codexの設定に、非公開のバックアップを作ってからマージします |
| `--file <value>`       | `--apply` で更新する設定ファイル（既定では標準の場所）                |

## lockpick mcp rollback

セットアップ後に変更されていなければ、LockpickのMCP設定のバックアップを復元します

```bash title="使い方"
lockpick mcp rollback <backup>
```

| 引数         | 役割                                  |
| ---------- | ----------------------------------- |
| `<backup>` | `mcp config --apply` が表示したバックアップのパス |

## lockpick skills

コーディングエージェントに Lockpick のスキルを追加します（npx skills add promptadvisers/lockpick-skills）

```bash title="使い方"
lockpick skills [options]
```

| 引数                | 役割                                         |
| ----------------- | ------------------------------------------ |
| `--agent <value>` | 追加先のエージェント（例: claude-code,codex）。既定では確認します |
| `--global`        | このプロジェクトではなく、あなたのユーザー全体に追加します              |

## lockpick docs

ターミナルからLockpickのドキュメントを検索します。CLIのガイドの一覧も表示できます。`--open` を付けると、最初の一致をブラウザーで開きます

```bash title="使い方"
lockpick docs [query] [options]
```

| 引数        | 役割                               |
| --------- | -------------------------------- |
| `<query>` | 探す内容（例: "fix a missing CSP"）     |
| `--open`  | 最も一致するページ（またはCLIのガイド）をブラウザーで開きます |

## lockpick ci init

GitHub Actionsのワークフロー（.github/workflows/lockpick.yml）を書き込みます。リリースのたびにPulseを実行し、重大な検出事項で失敗させます

```bash title="使い方"
lockpick ci init <site> [options]
```

| 引数                  | 役割                                                                        |
| ------------------- | ------------------------------------------------------------------------- |
| `<site>`            | 確認するサイトのIDまたは名前                                                           |
| `--fail-on <value>` | この重大度以上でワークフローを失敗させます: critical、high、medium、low（既定は high）。既定値は `high` です。 |
| `--file <value>`    | 書き込む場所（既定は .github/workflows/lockpick.yml）                                |
| `--action`          | npxでCLIを実行する代わりに、Lockpick GitHub Actionを使います（プレビュー）                       |
| `--force`           | 既存のワークフローファイルを置き換えます                                                      |
| `--dry-run`         | ファイルを書かずに、ワークフローを表示します                                                    |

## lockpick ci check

スキャンを開始せず、利用枠も使わずに、既存の評価を確認します

```bash title="使い方"
lockpick ci check <runId> [options]
```

| 引数                        | 役割                                                               |
| ------------------------- | ---------------------------------------------------------------- |
| `<runId>`                 | 評価する正確なランのID                                                     |
| `--max-age-hours <value>` | 完了からの最大経過時間（時間）。任意                                               |
| `--min-coverage <value>`  | 報告されたカバレッジの最小パーセント。不明な場合は失敗します。任意                                |
| `--fail-on <value>`       | 未解決の検出事項がこの重大度以上になったら終了コード8で終わります: critical、high、medium、low（CI用） |