chipflow.auth¶

ChipFlow authentication helper module.

Handles authentication for ChipFlow API with multiple fallback methods: 1. Environment variable CHIPFLOW_API_KEY 2. GitHub CLI token authentication (if gh is available) 3. OAuth 2.0 Device Flow

Exceptions¶

AuthenticationError

Exception raised when authentication fails.

Functions¶

`get_credentials_file`()	Get path to credentials file.
`save_api_key`(api_key[, origin])	Save API key for a given origin in the credentials file.
`load_saved_api_key`([origin])	Load saved API key for the given origin, or None if not present.
`is_gh_authenticated`()	Check if GitHub CLI is installed and authenticated.
`get_gh_token`()	Get GitHub token from gh CLI.
`authenticate_with_github_token`(api_origin[, interactive])	Authenticate using GitHub CLI token.
`authenticate_with_device_flow`(api_origin[, interactive])	Authenticate using OAuth 2.0 Device Flow.
`get_api_key`([api_origin, interactive, force_login])	Get API key using the following priority:
`logout`([origin])	Remove saved credentials.

Module Contents¶

exception chipflow.auth.AuthenticationError¶

Bases: Exception

Exception raised when authentication fails.

chipflow.auth.get_credentials_file()¶: Get path to credentials file.

chipflow.auth.save_api_key(api_key, origin=DEFAULT_API_ORIGIN)¶

Save API key for a given origin in the credentials file.

Parameters:

api_key (str)
origin (str)

chipflow.auth.load_saved_api_key(origin=DEFAULT_API_ORIGIN)¶

Load saved API key for the given origin, or None if not present.

Parameters:: origin (str)

chipflow.auth.is_gh_authenticated()¶: Check if GitHub CLI is installed and authenticated.

chipflow.auth.get_gh_token()¶: Get GitHub token from gh CLI.

chipflow.auth.authenticate_with_github_token(api_origin, interactive=True)¶

Authenticate using GitHub CLI token.

Parameters:

api_origin (str) – ChipFlow API origin URL
interactive (bool) – Whether to show interactive messages

Returns:

API key on success, None on failure

chipflow.auth.authenticate_with_device_flow(api_origin, interactive=True)¶

Authenticate using OAuth 2.0 Device Flow.

Parameters:

api_origin (str) – ChipFlow API origin URL
interactive (bool) – Whether to show interactive messages

Returns:

API key on success, raises AuthenticationError on failure

chipflow.auth.get_api_key(api_origin=None, interactive=True, force_login=False)¶

Get API key using the following priority: 1. CHIPFLOW_API_KEY environment variable 2. Saved credentials file (unless force_login is True) 3. GitHub CLI token authentication 4. Device flow authentication

Parameters:

api_origin (str | None) – ChipFlow API origin URL (defaults to CHIPFLOW_API_ORIGIN env var or production)
interactive (bool) – Whether to show interactive messages and prompts
force_login (bool) – Force re-authentication even if credentials exist

Returns:

API key string

Raises:

AuthenticationError – If all authentication methods fail

chipflow.auth.logout(origin=None)¶

Remove saved credentials.

If origin is given, only that origin’s key is removed; the file is deleted when no origins remain. If origin is None, the entire credentials file is deleted (legacy behaviour, used by chipflow auth logout without args).

Parameters:: origin (str | None)