Synopsis

homeboy auth <COMMAND>

Description

Manage project API secrets in the OS keychain.

Secrets are scoped by project ID and variable name. source: "keychain" API variables use service homeboy and account <project-id>:<variable-name>.

Subcommands

login

homeboy auth login --project <project_id> [--identifier <username_or_email>] [--password <password>]

If --identifier or --password are omitted, Homeboy prompts on stderr and reads from stdin.

login runs a configured login flow when the project defines one. For static API tokens, use set.

set

homeboy auth set --project <project_id> <variable> [value]

Stores a variable value in the OS keychain. If value is omitted, Homeboy prompts and reads the value from stdin.

Example:

homeboy auth set --project wpcloud-api token

get

homeboy auth get --project <project_id> <variable> [--redacted]

Reads a variable from the OS keychain. Use --redacted to confirm presence without printing the secret.

remove

homeboy auth remove --project <project_id> <variable>

Deletes one variable from the OS keychain.

logout

homeboy auth logout --project <project_id>

Deletes keychain-backed variables configured in the project’s api.auth.variables map.

status

homeboy auth status --project <project_id>

Reports whether configured auth variables are available without printing secret values.

Output

JSON output is wrapped in the global envelope.

data is one of:

• { "command": "login", "project_id": "...", "success": true }
• { "command": "set", "project_id": "...", "variable": "token", "stored": true }
• { "command": "get", "project_id": "...", "variable": "token", "value": "********", "redacted": true }
• { "command": "remove", "project_id": "...", "variable": "token", "removed": true }
• { "command": "logout", "project_id": "...", "removed": 1 }
• { "command": "status", "project_id": "...", "authenticated": true, "variables": [...] }

Note: command is a tagged enum value, and fields use snake_case (project_id).

Related

• api
• project
• JSON output contract