Skip to content
Simpcat Simpcat Simpcat

simpcat.login()

simpcat.login(key: str | None = None, host: str | None = None) -> bool

Programmatic login. Matches wandb.login() interface.

Shells out to the simpcat login CLI binary to verify the key and store credentials in ~/.simpcat/config.toml.

Parameters

Section titled “Parameters”
  • key — API key. If None, prompts interactively.
  • host — Server host. Defaults to the CLI default host (app.simpcat.ai) or SIMPCAT_HOST env var.

Returns

Section titled “Returns”

bool — True if login succeeded, False otherwise.

Raises

Section titled “Raises”
  • RuntimeError — If the simpcat binary is not found.