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

# simforge login

> Reference for simforge login: usage, arguments and flags, generated from the CLI.

Generated from the CLI's own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the [command reference](/cli).

## login

Sign in to a SimForge host (browser approval, or --device for a URL and code)

```sh theme={null}
simforge login [OPTIONS]
       simforge login <COMMAND>
```

| Argument / flag | Notes | What |
| - | - | - |
| `--host HOST` | | SimForge host to sign in to. Default: SIMFORGE\_HOST, then the host of the last login, then simforge.ai. Later commands use the host signed in to |
| `--device` | | Sign in with a code instead of a local browser: print a URL and a short code to approve from any browser (SSH, headless machines) |
| `--scope SCOPE` | repeatable | A scope to request on top of the defaults (repeatable), such as keys:admin to manage API keys. The defaults cover map/runtime downloads and scenario/cloud jobs |
| `--credential-store STORE` | one of auto, keyring, file | Where to keep the tokens. Default: SIMFORGE\_CREDENTIAL\_STORE, then auto (the OS keychain, else a 0600 file; the output says which and why) |
| `--device-name NAME` | | The name the approval page and the CLI sessions list show for this machine. Default: the host name |
| `--timeout SECONDS` | default 600 | Seconds to wait for the approval |
| `--no-wait` | | With --device: print the URL and code and exit at once instead of waiting; after the approval, `simforge login poll` (from any shell, even after this one closed) stores the login |

## login poll

Finish a device sign-in started by `login --device --no-wait` (or one whose terminal closed while it waited): wait for the approval, then store the login

```sh theme={null}
simforge login poll [OPTIONS]
```

| Argument / flag | Notes | What |
| - | - | - |
| `--host HOST` | | SimForge host to sign in to. Default: SIMFORGE\_HOST, then the host of the last login, then simforge.ai. Later commands use the host signed in to |
| `--device` | | Sign in with a code instead of a local browser: print a URL and a short code to approve from any browser (SSH, headless machines) |
| `--scope SCOPE` | repeatable | A scope to request on top of the defaults (repeatable), such as keys:admin to manage API keys. The defaults cover map/runtime downloads and scenario/cloud jobs |
| `--credential-store STORE` | one of auto, keyring, file | Where to keep the tokens. Default: SIMFORGE\_CREDENTIAL\_STORE, then auto (the OS keychain, else a 0600 file; the output says which and why) |
| `--device-name NAME` | | The name the approval page and the CLI sessions list show for this machine. Default: the host name |
| `--timeout SECONDS` | default 600 | Seconds to wait for the approval |
| `--no-wait` | | With --device: print the URL and code and exit at once instead of waiting; after the approval, `simforge login poll` (from any shell, even after this one closed) stores the login |
| `--host HOST` | | SimForge host the sign-in was started on. Default: SIMFORGE\_HOST, then the host of the last login, then simforge.ai |
| `--timeout SECONDS` | default 600 | Seconds to wait for the approval; the code stays valid until it expires, so a timeout (`login_pending`) can be polled again |


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