> ## Documentation Index
> Fetch the complete documentation index at: https://chainpatrol.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Instala la CLI de ChainPatrol

> Instala la CLI de ChainPatrol desde npm, apúntala a un entorno de la API, define una organización predeterminada y activa el autocompletado del shell en zsh o bash.

## Requisitos

* Node.js 20 o superior
* Un gestor de paquetes compatible con npm

## Instalación

```bash npm theme={null}
npm install -g @chainpatrol/cli
```

```bash pnpm theme={null}
pnpm add -g @chainpatrol/cli
```

```bash yarn theme={null}
yarn global add @chainpatrol/cli
```

El paquete instala un único binario `chainpatrol`. Verifícalo:

```bash theme={null}
chainpatrol --version
chainpatrol --help
```

> [!NOTE]
>
> El paquete de npm es `@chainpatrol/cli`. El paquete `chainpatrol` sin scope en npm es un
> marcador de posición (placeholder) para el [SDK de JavaScript](https://chainpatrol.com/docs/es/sdk/overview.md) y no
> contiene la CLI.

Para ejecutarla una vez sin instalarla de forma global:

```bash theme={null}
npx @chainpatrol/cli asset check https://phish.example
```

## Actualización

```bash theme={null}
npm install -g @chainpatrol/cli@latest
```

Mientras se ejecuta tu comando, la CLI consulta npm en segundo plano para ver si hay una
versión más nueva y muestra un aviso de una línea cuando existe. La verificación se omite
en los modos `--json` y `--quiet` para que nunca pueda corromper la salida legible por
máquinas, y nunca retrasa tu comando más de medio segundo.

## Configuración

La configuración se guarda en `config.json`, dentro del directorio de configuración de la CLI:

* `$XDG_CONFIG_HOME/chainpatrol/` (por defecto, `~/.config/chainpatrol/`)
* `~/.chainpatrol/` se sigue usando si ya existe y el directorio XDG no
* `$CHAINPATROL_CONFIG_DIR` tiene prioridad sobre ambos

```json ~/.config/chainpatrol/config.json theme={null}
{
  "apiUrl": "https://app.chainpatrol.io",
  "defaultOrg": "acme"
}
```

| Clave | Descripción |
| - | - |
| `apiUrl` | URL base de la API. El valor predeterminado es `https://app.chainpatrol.io`. |
| `defaultOrg` | Slug de la organización que se usa cuando un comando necesita uno y se omite `--org`. |

### Definir una organización predeterminada

La mayoría de los comandos con alcance de organización aceptan `--org <slug>`. Al pasarlo,
el slug se guarda como tu valor predeterminado, así que los comandos posteriores pueden
omitirlo:

```bash theme={null}
chainpatrol configs list --org acme   # saves "acme" as the default
chainpatrol configs list              # reuses it
```

La organización se resuelve en este orden:

**1. Flag --org**

Un `--org <slug>` explícito siempre gana, y se escribe de vuelta en `config.json`.

**2. Valor predeterminado guardado**

`defaultOrg` de `config.json`.

**3. Variable de entorno**

`CHAINPATROL_ORG`, útil en CI, donde no quieres escribir un archivo de configuración.

Si ninguno de ellos se resuelve, el comando falla con
`Organization required. Use --org <slug> to specify one.` y el [código de salida
`3`](https://chainpatrol.com/docs/es/cli/output#códigos-de-salida).

> [!TIP]
>
> Los comandos autenticados con una clave de API con alcance de organización resuelven la
> organización del lado del servidor a partir de la clave, así que `--org` es opcional para
> ellos.

### Variables de entorno

| Variable | Propósito |
| - | - |
| `CHAINPATROL_API_KEY` | Clave de API con la que autenticarte en lugar de una sesión de inicio de sesión guardada. Consulta [Autenticación](https://chainpatrol.com/docs/es/cli/authentication.md#autenticación-con-clave-de-api). |
| `CHAINPATROL_API_URL` | Reemplaza la URL base predeterminada de la API. |
| `CHAINPATROL_CONFIG_DIR` | Reemplaza el directorio de configuración. |
| `CHAINPATROL_ORG` | Slug de organización de respaldo. |
| `NO_COLOR` | Desactiva la salida con colores, igual que `--no-color`. |

## Autocompletado del shell

`chainpatrol setup` instala el autocompletado por ti. Para escribir el script tú mismo:

```bash zsh theme={null}
chainpatrol completions zsh > "${fpath[1]}/_chainpatrol"
```

```bash bash theme={null}
chainpatrol completions bash > ~/.chainpatrol-completions.bash
echo 'source ~/.chainpatrol-completions.bash' >> ~/.bashrc
```

Reinicia tu shell para que lo tome.

## Desinstalación

```bash theme={null}
chainpatrol uninstall        # remove the Claude Code skill and completions
npm uninstall -g @chainpatrol/cli
```

Para eliminar también las credenciales y la configuración guardadas, borra el directorio de
configuración:

```bash theme={null}
chainpatrol logout
rm -rf ~/.config/chainpatrol
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.