# Comandos

Cada comando de lockpick y sus opciones, generados desde la propia CLI.

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

Lockpick desde tu terminal: comprobaciones rápidas, sitios, estado, hallazgos, resúmenes de corrección, escaneos Pulse, escaneos Deep que apruebas y revisiones para ti y para tus agentes de programación.

Ejecuta `lockpick <command> --help` para ver las mismas opciones en tu terminal. Cada comando también acepta `--host` y `--json`.

## lockpick login

Inicia sesión desde el navegador y guarda una clave para un espacio de trabajo

```bash title="Uso"
lockpick login [options]
```

| Argumento      | Qué hace                                                                                                                   |
| -------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `--no-browser` | Muestra el enlace de inicio de sesión sin abrir el navegador                                                               |
| `--pulse`      | Pide permiso para iniciar escaneos Pulse, comprobaciones rápidas y volver a revisar DNS gratis (lo marcas en el navegador) |
| `--sites`      | Pide permiso para añadir sitios y cambiar tu sitio gratuito (lo marcas en el navegador)                                    |
| `--deep`       | Pide permiso para preparar escaneos Deep que apruebas en Lockpick (lo marcas en el navegador)                              |
| `--local`      | Solicitar permiso para evaluaciones locales                                                                                |

## lockpick logout

Revoca la clave de esta terminal y la olvida

```bash title="Uso"
lockpick logout
```

## lockpick whoami

Muestra el usuario, el espacio de trabajo y la clave que usa esta terminal

```bash title="Uso"
lockpick whoami
```

## lockpick doctor

Revisa la CLI, el host, la conexión, la autenticación y el acceso al espacio de trabajo sin iniciar un escaneo

```bash title="Uso"
lockpick doctor [options]
```

| Argumento         | Qué hace                                         |
| ----------------- | ------------------------------------------------ |
| `--scope <value>` | Ámbito que comprobar: pulse, sites, deep o local |

## lockpick projects

Lista los proyectos con sus últimos escaneos Pulse y Deep

```bash title="Uso"
lockpick projects
```

## lockpick status

Informe de estado de un proyecto (o un resumen de todos)

```bash title="Uso"
lockpick status [project]
```

| Argumento   | Qué hace                 |
| ----------- | ------------------------ |
| `<project>` | Id o nombre del proyecto |

## lockpick sites

Lista los sitios, añade uno con `lockpick sites add \<url\>` o mueve el Pulse gratuito con `lockpick sites switch \<siteId\> --yes`

```bash title="Uso"
lockpick sites
```

## lockpick sites add

Añade un sitio que sea tuyo o que tengas permiso para probar (necesita una clave que permita añadir sitios). Añadirlo no lo escanea.

```bash title="Uso"
lockpick sites add <url> [options]
```

| Argumento        | Qué hace                                                                        |
| ---------------- | ------------------------------------------------------------------------------- |
| `<url>`          | Dirección del sitio, por ejemplo [https://atlas.example](https://atlas.example) |
| `--name <value>` | Nombre que se muestra en Lockpick                                               |

## lockpick sites switch

Elimina el sitio que tiene el Pulse gratuito de este mes para que otro sitio pueda usarlo (necesita una clave que permita añadir sitios e iniciar Pulse). Con --check, también inicia un Pulse en el sitio de esa comprobación rápida, usando un Pulse gratuito.

```bash title="Uso"
lockpick sites switch <site> [options]
```

| Argumento         | Qué hace                                                                           |
| ----------------- | ---------------------------------------------------------------------------------- |
| `<site>`          | Id del sitio que se va a eliminar (de `lockpick sites`)                            |
| `--check <value>` | Id de la comprobación rápida del nuevo sitio; su Pulse empieza con el cambio       |
| `--yes`           | Confirma la eliminación. El sitio deja de vigilarse; puede restaurarse en Lockpick |

## lockpick runs

Lista los escaneos Pulse y Deep, del más reciente al más antiguo

```bash title="Uso"
lockpick runs [options]
```

| Argumento           | Qué hace                                                                          |
| ------------------- | --------------------------------------------------------------------------------- |
| `--project <value>` | Id o nombre del proyecto                                                          |
| `--kind <value>`    | pulse \| box                                                                      |
| `--status <value>`  | queued \| running \| cancelling \| succeeded \| incomplete \| failed \| cancelled |
| `--limit <value>`   | Cuántos (predeterminado 20, máximo 100)                                           |

## lockpick run

Muestra un escaneo

```bash title="Uso"
lockpick run <runId>
```

| Argumento | Qué hace       |
| --------- | -------------- |
| `<runId>` | Id del escaneo |

## lockpick watch

Sigue un escaneo hasta que termine (sale con 3 a menos que tenga éxito)

```bash title="Uso"
lockpick watch <runId> [options]
```

| Argumento            | Qué hace                                                                                                |
| -------------------- | ------------------------------------------------------------------------------------------------------- |
| `<runId>`            | Id del escaneo                                                                                          |
| `--fail-on <value>`  | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI) |
| `--interval <value>` | Segundos entre comprobaciones (predeterminado 5, aumenta hasta 30)                                      |
| `--timeout <value>`  | Espera máxima en segundos (predeterminado 600, máximo 3600)                                             |

## lockpick pulse

Inicia un escaneo Pulse en un proyecto y espera el resultado (necesita una clave que permita iniciar Pulses)

```bash title="Uso"
lockpick pulse <project> [options]
```

| Argumento            | Qué hace                                                                                                                                                         |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<project>`          | Id o nombre del proyecto                                                                                                                                         |
| `--no-wait`          | Responde en cuanto empieza el escaneo, sin esperar el resultado                                                                                                  |
| `--interval <value>` | Segundos entre comprobaciones mientras espera (predeterminado 5)                                                                                                 |
| `--timeout <value>`  | Espera máxima en segundos (predeterminado 600, máximo 3600)                                                                                                      |
| `--fail-on <value>`  | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI)                                                          |
| `--lockfile`         | Envía (o con --no-lockfile, nunca envía) los nombres y versiones de los paquetes de esta carpeta para este escaneo; si no, Lockpick pregunta una vez por carpeta |

## lockpick recheck

Revisión completa de un sitio: un Pulse nuevo que usa un escaneo Pulse del cupo. Con --dns \<findingId>, vuelve a revisar DNS de forma gratuita un hallazgo de un escaneo, lo que nunca cambia su nota.

```bash title="Uso"
lockpick recheck <target> [options]
```

| Argumento            | Qué hace                                                                                                                                                         |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<target>`           | Id o nombre del sitio; con --dns, el id del escaneo                                                                                                              |
| `--dns <value>`      | Id del hallazgo que volver a revisar con los registros DNS públicos (gratis, nunca contacta el sitio)                                                            |
| `--no-wait`          | Responde en cuanto empieza el escaneo, sin esperar el resultado                                                                                                  |
| `--interval <value>` | Segundos entre comprobaciones mientras espera (predeterminado 5)                                                                                                 |
| `--timeout <value>`  | Espera máxima en segundos (predeterminado 600, máximo 3600)                                                                                                      |
| `--fail-on <value>`  | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI)                                                          |
| `--lockfile`         | Envía (o con --no-lockfile, nunca envía) los nombres y versiones de los paquetes de esta carpeta para este escaneo; si no, Lockpick pregunta una vez por carpeta |

## lockpick deps

Envía los nombres y versiones exactas de los paquetes de este proyecto (nunca código) a un sitio, y lista los avisos que los afectan. Lee package-lock.json, npm-shrinkwrap.json, pnpm-lock.yaml, yarn.lock, requirements.txt y poetry.lock (necesita una clave que permita gestionar sitios).

```bash title="Uso"
lockpick deps <site> [options]
```

| Argumento                | Qué hace                                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------------------- |
| `<site>`                 | Id o nombre del sitio                                                                                   |
| `--path <value>`         | Carpeta del proyecto con los archivos de bloqueo (predeterminado: esta carpeta)                         |
| `--completeness <value>` | complete, partial o unknown (predeterminado unknown; declara complete solo para un inventario completo) |
| `--revision <value>`     | Revisión del código fuente opcional; no demuestra el despliegue                                         |
| `--environment <value>`  | production, staging, development o unknown                                                              |
| `--dry-run`              | Solo muestra lo que se enviaría                                                                         |
| `--forget`               | Olvida la lista de paquetes del sitio en Lockpick                                                       |

## lockpick monitor

Explora los avisos de seguridad actuales y las coincidencias de los sitios que puedes leer.

```bash title="Uso"
lockpick monitor [options]
```

| Argumento             | Qué hace                                               |
| --------------------- | ------------------------------------------------------ |
| `--site <value>`      | Filtra por id o nombre de sitio                        |
| `--query <value>`     | Busca por id, título o nombre de paquete de los avisos |
| `--ecosystem <value>` | all, npm, pypi, composer o wordpress                   |
| `--kind <value>`      | all, vulnerability o malicious_package                 |
| `--view <value>`      | latest, sites, exploited o following                   |
| `--severity <value>`  | all, critical, high, medium, low o unknown             |
| `--days <value>`      | 7, 30, 90, 365 o 0 para todo el historial              |
| `--cursor <value>`    | Cursor siguiente de una respuesta anterior             |
| `--advisory <value>`  | Lee un id de aviso                                     |

## lockpick check

Comprobación rápida gratuita de un sitio web (página de inicio y DNS público), o de un repositorio público de GitHub antes de instalarlo: una skill, un plugin, un servidor MCP o una app (necesita una clave que permita iniciar Pulses)

```bash title="Uso"
lockpick check <url> [options]
```

| Argumento           | Qué hace                                                                                                                                                                                                                     |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<url>`             | Dirección del sitio web (atlas.example) o repositorio de GitHub (github.com/owner/repo, owner/repo)                                                                                                                          |
| `--no-wait`         | Responde en cuanto empieza el escaneo, sin esperar el resultado                                                                                                                                                              |
| `--timeout <value>` | Espera máxima en segundos (predeterminado 90, máximo 3600)                                                                                                                                                                   |
| `--deep`            | Para un repositorio de GitHub: una revisión Deep del repositorio. También lee cada lockfile y los últimos 50 commits en busca de claves filtradas, con una revisión más sólida. Necesita el plan Deep y usa un escaneo Deep. |

## lockpick verify

Verifica una vez que eres dueño de un sitio. Muestra el valor del sitio y dónde publicarlo, y --wait lo busca (necesita una clave que permita preparar escaneos Deep)

```bash title="Uso"
lockpick verify <site> [options]
```

| Argumento          | Qué hace                                                                                                 |
| ------------------ | -------------------------------------------------------------------------------------------------------- |
| `<site>`           | Id o nombre del sitio                                                                                    |
| `--method <value>` | dns (predeterminado), file o meta (una etiqueta en el head de la página de inicio) Predeterminado `dns`. |
| `--wait`           | Sigue buscándolo durante unos cinco minutos (usa las comprobaciones de la prueba)                        |

## lockpick deep local

Ejecutar comprobaciones locales deterministas tras autorizar el proyecto

```bash title="Uso"
lockpick deep local <path> [options]
```

| Argumento                     | Qué hace                                                                                                       |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `<path>`                      | Ruta física del repositorio (pwd -P); sin enlaces simbólicos en la raíz                                        |
| `--project <value>`           | ID del proyecto o nombre inequívoco                                                                            |
| `--browser-artifacts <value>` | Directorio de artefactos del navegador relativo al repositorio; se puede repetir                               |
| `--env-file <value>`          | Archivo de entorno explícito relativo al repositorio; se puede repetir                                         |
| `--dockerfile <value>`        | Ruta del Dockerfile relativa al repositorio; repetible                                                         |
| `--migration-file <value>`    | Archivo de migración SQL relativo al repositorio; repetir en orden de ejecución                                |
| `--build-context <value>`     | Contexto de compilación relativo al repositorio; emparejar con --dockerfile en el mismo orden (. para la raíz) |
| `--checks <value>`            | ID de comprobaciones separados por comas; las solicitadas no compatibles permanecen incompletas                |
| `--history`                   | Incluir una inspección limitada del historial de Git                                                           |
| `--source-maps`               | Inspeccionar fuentes integradas en los mapas de código del navegador proporcionados                            |
| `--fail-on <value>`           | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI)        |

## lockpick deep verify

Inicia una prueba de propiedad para un escaneo Deep: un registro DNS TXT, un archivo o una etiqueta meta de la página de inicio que publiques (necesita una clave que permita preparar escaneos Deep)

```bash title="Uso"
lockpick deep verify <site> [options]
```

| Argumento          | Qué hace                                                                                                 |
| ------------------ | -------------------------------------------------------------------------------------------------------- |
| `<site>`           | Id o nombre del sitio                                                                                    |
| `--method <value>` | dns (predeterminado), file o meta (una etiqueta en el head de la página de inicio) Predeterminado `dns`. |
| `--wait`           | Sigue buscándolo durante unos cinco minutos (usa las comprobaciones de la prueba)                        |

## lockpick deep check

Busca una vez una prueba de propiedad publicada (cada comprobación usa uno de sus intentos)

```bash title="Uso"
lockpick deep check <site> <verificationId>
```

| Argumento          | Qué hace                      |
| ------------------ | ----------------------------- |
| `<site>`           | Id o nombre del sitio         |
| `<verificationId>` | El id de lockpick deep verify |

## lockpick deep prepare

Prepara un escaneo Deep con una prueba verificada y abre su página de aprobación; no empieza nada hasta que lo apruebes en Lockpick

```bash title="Uso"
lockpick deep prepare <site> <verificationId> [options]
```

| Argumento          | Qué hace                                               |
| ------------------ | ------------------------------------------------------ |
| `<site>`           | Id o nombre del sitio                                  |
| `<verificationId>` | El id de la prueba verificada                          |
| `--no-browser`     | Muestra el enlace de aprobación sin abrir el navegador |

## lockpick deep start

Inicia un escaneo Deep que aprobaste en Lockpick y espera a que termine (un escaneo Deep del cupo, como se muestra al prepararlo)

```bash title="Uso"
lockpick deep start <operationId> [options]
```

| Argumento            | Qué hace                                                                                                |
| -------------------- | ------------------------------------------------------------------------------------------------------- |
| `<operationId>`      | El id de lockpick deep prepare                                                                          |
| `--no-wait`          | Responde en cuanto empieza el escaneo, sin esperar el resultado                                         |
| `--interval <value>` | Segundos entre comprobaciones mientras espera (predeterminado 5)                                        |
| `--timeout <value>`  | Espera máxima en segundos (predeterminado 600, máximo 3600)                                             |
| `--fail-on <value>`  | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI) |

## lockpick findings

Hallazgos de un escaneo que necesitan atención

```bash title="Uso"
lockpick findings <runId> [options]
```

| Argumento            | Qué hace                                                                                                |
| -------------------- | ------------------------------------------------------------------------------------------------------- |
| `<runId>`            | Id del escaneo                                                                                          |
| `--severity <value>` | critical \| high \| medium \| low \| info                                                               |
| `--all`              | Incluye las comprobaciones aprobadas y las no evaluadas                                                 |
| `--fail-on <value>`  | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI) |

## lockpick report

Exporta una evaluación existente y sus hallazgos anonimizados como Markdown o JSON

```bash title="Uso"
lockpick report <runId> [options]
```

| Argumento       | Qué hace                                                             |
| --------------- | -------------------------------------------------------------------- |
| `<runId>`       | Id del escaneo                                                       |
| `--out <value>` | Crea un archivo de informe nuevo; no sobrescribe archivos existentes |

## lockpick finding

Muestra un hallazgo con su evidencia

```bash title="Uso"
lockpick finding <runId> <findingId>
```

| Argumento     | Qué hace                         |
| ------------- | -------------------------------- |
| `<runId>`     | Id del escaneo                   |
| `<findingId>` | Id. del hallazgo o su código LP- |

## lockpick brief

Resumen en Markdown que corrige todo lo que necesita atención en un escaneo (o un hallazgo)

```bash title="Uso"
lockpick brief <runId> [options]
```

| Argumento           | Qué hace                                                                                        |
| ------------------- | ----------------------------------------------------------------------------------------------- |
| `<runId>`           | Id del escaneo                                                                                  |
| `--finding <value>` | Solo este hallazgo                                                                              |
| `--agent <value>`   | Adáptalo a este agente: claude-code, codex, cursor, vscode, opencode, lovable, bolt, replit, v0 |
| `--out <value>`     | Escribe el Markdown en este archivo                                                             |

## lockpick fix

Guarda el resumen de corrección de todo en lockpick-fixes.md e imprime el comando que inicia tu agente con él

```bash title="Uso"
lockpick fix <runId> [options]
```

| Argumento         | Qué hace                                                                                        |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| `<runId>`         | Id del escaneo                                                                                  |
| `--agent <value>` | Adáptalo a este agente: claude-code, codex, cursor, vscode, opencode, lovable, bolt, replit, v0 |
| `--out <value>`   | Dónde guardar el resumen (predeterminado: lockpick-fixes.md)                                    |

## lockpick compare

Compara una revisión Pulse con su línea base

```bash title="Uso"
lockpick compare <runId>
```

| Argumento | Qué hace                   |
| --------- | -------------------------- |
| `<runId>` | Id del escaneo de revisión |

## lockpick import

Lee un archivo findings.json de Codex Security o SARIF y lo correlaciona con un escaneo, en tu equipo

```bash title="Uso"
lockpick import <file> [options]
```

| Argumento       | Qué hace                                                                                                         |
| --------------- | ---------------------------------------------------------------------------------------------------------------- |
| `<file>`        | Ruta al archivo findings.json o a un archivo SARIF 2.1.0                                                         |
| `--run <value>` | Correlaciona con este id de escaneo (omítelo para solo leer el archivo)                                          |
| `--upload`      | Crea las claves mínimas de correlación (rutas, ids de regla, gravedades) para compartir; desactivado por defecto |

## lockpick open

Abre un escaneo o proyecto en el navegador

```bash title="Uso"
lockpick open <id>
```

| Argumento | Qué hace                                           |
| --------- | -------------------------------------------------- |
| `<id>`    | Id de escaneo, id de proyecto o nombre de proyecto |

## lockpick mcp

Ejecuta el servidor MCP por stdio para un agente de programación

```bash title="Uso"
lockpick mcp [options]
```

| Argumento              | Qué hace                                                   |
| ---------------------- | ---------------------------------------------------------- |
| `--local-root <value>` | Raíz local absoluta para habilitar análisis MCP; repetible |

## lockpick mcp config

Muestra la configuración de MCP para claude, cursor, vscode, codex

```bash title="Uso"
lockpick mcp config <client> [options]
```

| Argumento              | Qué hace                                                                                   |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| `<client>`             | claude \| cursor \| vscode \| codex                                                        |
| `--local-root <value>` | Raíz local absoluta para habilitar análisis MCP; repetible                                 |
| `--hosted`             | Usa el conector OAuth alojado en lugar del servidor stdio local                            |
| `--apply`              | Combina con la configuración de Cursor, VS Code o Codex con una copia de seguridad privada |
| `--file <value>`       | Archivo de configuración que actualizar con --apply (por defecto, la ubicación estándar)   |

## lockpick mcp rollback

Restaura una copia de seguridad de la configuración MCP de Lockpick si no ha cambiado desde la configuración

```bash title="Uso"
lockpick mcp rollback <backup>
```

| Argumento  | Qué hace                                                     |
| ---------- | ------------------------------------------------------------ |
| `<backup>` | Ruta de la copia de seguridad que muestra mcp config --apply |

## lockpick skills

Añade las skills de Lockpick a tu agente de programación (npx skills add promptadvisers/lockpick-skills)

```bash title="Uso"
lockpick skills [options]
```

| Argumento         | Qué hace                                                                               |
| ----------------- | -------------------------------------------------------------------------------------- |
| `--agent <value>` | Agentes a los que añadirlas, por ejemplo claude-code,codex (predeterminado: preguntar) |
| `--global`        | Añadirlas para tu usuario en lugar de este proyecto                                    |

## lockpick docs

Busca en la documentación de Lockpick desde la terminal, o lista las guías de la CLI (--open abre la primera coincidencia)

```bash title="Uso"
lockpick docs [query] [options]
```

| Argumento | Qué hace                                                         |
| --------- | ---------------------------------------------------------------- |
| `<query>` | Qué buscar, por ejemplo "corregir un CSP que falta"              |
| `--open`  | Abre la mejor coincidencia (o la guía de la CLI) en el navegador |

## lockpick ci init

Escribe un flujo de trabajo de GitHub Actions (.github/workflows/lockpick.yml) que ejecuta un Pulse en cada versión y falla con hallazgos graves

```bash title="Uso"
lockpick ci init <site> [options]
```

| Argumento           | Qué hace                                                                                                                            |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `<site>`            | Id o nombre del sitio que revisar                                                                                                   |
| `--fail-on <value>` | Hace fallar el flujo de trabajo con esta gravedad o peor: critical, high, medium, low (predeterminado high). Predeterminado `high`. |
| `--file <value>`    | Dónde escribirlo (predeterminado .github/workflows/lockpick.yml)                                                                    |
| `--action`          | Usa la acción de GitHub de Lockpick en lugar de ejecutar la CLI con npx (versión preliminar)                                        |
| `--force`           | Reemplaza un archivo de flujo de trabajo existente                                                                                  |
| `--dry-run`         | Muestra el flujo de trabajo en lugar de escribirlo                                                                                  |

## lockpick ci check

Comprueba una evaluación existente sin iniciar un escaneo ni consumir cupo

```bash title="Uso"
lockpick ci check <runId> [options]
```

| Argumento                 | Qué hace                                                                                                |
| ------------------------- | ------------------------------------------------------------------------------------------------------- |
| `<runId>`                 | Id exacto del escaneo que evaluar                                                                       |
| `--max-age-hours <value>` | Antigüedad máxima desde que terminó, en horas (opcional)                                                |
| `--min-coverage <value>`  | Porcentaje mínimo de cobertura informado; lo desconocido falla (opcional)                               |
| `--fail-on <value>`       | Sale con 8 cuando los hallazgos abiertos son así de graves o más: critical, high, medium, low (para CI) |