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

# rig login

> Authenticate with Rigbox

Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`).

Use this command from your local terminal. Signing in also sets up SSH access to your workspaces from this machine, as `rig ssh add` does. Without a terminal, set `RIG_API_KEY` for each command or pipe a key to `rig login --import-token`. Inside a workspace, this command refuses with a one-line message; run it from your laptop. The CLI there is already signed in as the workspace.

## Examples

Authenticate from your local terminal; complete browser approval.

```bash theme={null}
rig login
```

Inspect the supported arguments before running this command. Help is offline and does not modify resources.

```bash theme={null}
rig login --help
```

## Local syntax

```text theme={null}
Usage: rigbox login [OPTIONS]
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `-t, --token` | Paste a token instead of opening the browser | Default: false |
| `-i, --import-token` | Read a token from stdin and validate it | Default: false; Conflicts: token |
| `--output` | Output format \[default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--cli-input-json` | Read inputs from a JSON file or '-' (stdin) | Global; Value: FILE |
| `--cli-input-yaml` | Read inputs from a YAML file or '-' (stdin) | Global; Value: FILE; Conflicts: cli\_input\_json |
| `--generate-cli-skeleton` | Print a fillable input template, then exit | Global; Default: false |
| `--no-pager` | Do not pipe help output through a pager | Global; Default: false |
| `-v, --verbose` | Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` | Global; Default: false |
| `-h, --help` | Print help | |

> **Complete command help**
>
> ```text theme={null}
> Authenticate with Rigbox
>
> Usage: rigbox login [OPTIONS]
>
> Options:
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -t, --token
>           Paste a token instead of opening the browser
>
>   -i, --import-token
>           Read a token from stdin and validate it
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>       --cli-input-json <FILE>
>           Read inputs from a JSON file or '-' (stdin)
>
>       --cli-input-yaml <FILE>
>           Read inputs from a YAML file or '-' (stdin)
>
>       --generate-cli-skeleton
>           Print a fillable input template, then exit
>
>       --no-pager
>           Do not pipe help output through a pager
>
>   -v, --verbose
>           Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`
>
>   -h, --help
>           Print help
> ```


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