Docs menu

// Command reference

simforge login

Generated from the CLI's own help (CLI 0.2.0-rc.9). Global flags and exit codes are on the reference index.

All commands

simforge login

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

simforge login [OPTIONS]
       simforge login <COMMAND>
Argument / flagNotesWhat
--host HOSTSimForge 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
--deviceSign 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 SCOPErepeatableA 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 STOREone of auto, keyring, fileWhere 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 NAMEThe name the approval page and the CLI sessions list show for this machine. Default: the host name
--timeout SECONDSdefault 600Seconds to wait for the approval
--no-waitWith --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

simforge 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

simforge login poll [OPTIONS]
Argument / flagNotesWhat
--host HOSTSimForge 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
--deviceSign 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 SCOPErepeatableA 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 STOREone of auto, keyring, fileWhere 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 NAMEThe name the approval page and the CLI sessions list show for this machine. Default: the host name
--timeout SECONDSdefault 600Seconds to wait for the approval
--no-waitWith --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 HOSTSimForge host the sign-in was started on. Default: SIMFORGE_HOST, then the host of the last login, then simforge.ai
--timeout SECONDSdefault 600Seconds to wait for the approval; the code stays valid until it expires, so a timeout (login_pending) can be polled again