Skip to content

Authentication

HomeCloud CLI uses two auth modes depending on the command.

Console login (JWT)

For control-plane commands: login, accounts, queues list.

homecloud login --username alice
# Password prompted interactively, or:
homecloud login --username alice --password '...'

Important

Login uses username, not email. The console API field is username.

MFA

Platform admins with MFA enabled must complete a second factor:

Method How
TOTP / backup code Prompted in the terminal, or --mfa-code
Passkey / security key homecloud login --browser
homecloud login --username alice --mfa-code 123456
homecloud login --browser

Any console API call that returns MFA_REQUIRED is completed by a central CLI MFA handler (login challenge or step-up) — commands do not implement MFA themselves.

Session is stored in ~/.homecloud/session per profile.

Access Key (data plane)

For mq, so ls-buckets/ls/cp/sync/rm:

homecloud configure

Or inline (ideal for CI):

homecloud \
  --access-key-id "$HOMECLOUD_ACCESS_KEY_ID" \
  --secret-access-key "$HOMECLOUD_SECRET_ACCESS_KEY" \
  so sync ./dist so://my-bucket/ --delete

No account_id needed — resolved via /access-key/whoami on the SO gateway.

Access Keys do not use Console MFA on each request. Create them once while signed in (including MFA) in the Console.

Profiles

homecloud --profile production so ls media
homecloud configure --profile production

Credentials file: ~/.homecloud/credentials