HomeCloud CLI¶

The homecloud CLI is the command-line tool for account owners and DevOps. Use it to configure Access Keys, log in for management commands, sync object storage, publish queue messages, invoke functions, and more.

It ships as a standalone binary — end users do not need Python installed.

Install¶

See Install for Linux, macOS, and Windows.

homecloud version
homecloud configure
homecloud login

Mental model¶

Command family	Auth	Examples
Data plane	Access Key (`homecloud configure`)	`so cp`, `so sync`, `mq send`, `mq receive`
Management	Console session (`homecloud login`)	`queues list`, `so ls-buckets`, `apps list`, `accounts list`, `tasks`, `diagrams`
Either / mixed	See each command page	`fn`, `ir`, `mail`, user-bound key for `tasks` / `diagrams`

Create keys: Access Keys. Details: Authentication.

Quick examples¶

# Object storage — deploy a static site
homecloud so sync ./dist so://my-website/ --delete

# Queues
homecloud mq send orders --body '{"id":1}'
homecloud mq receive orders --max-messages 5 --delete

# Functions
homecloud fn invoke hello --payload '{"name":"Ada"}'

# Registry
homecloud ir login
homecloud ir repo list

# Mail
homecloud mail mailboxes

# Tasks / diagrams (login or user-bound Access Key)
homecloud tasks list --status open
homecloud diagrams list

Command reference¶

Page	Contents
All commands	Table of every command group
configure	Save Access Key profiles
login	Browser / password session
so	Object storage
mq	Message queues
fn	Functions
ir	Image registry
mail	Mail
tasks	Tasks tracker
MCP	Platform MCP server for AI tools
diagrams	Architecture diagrams
Releases	Version history / update

Output formats¶

homecloud queues list --output table   # default for many lists
homecloud mq send q --body '{}' --output json
homecloud so sync ./dist so://b/ --output json   # CI-friendly

URI scheme¶

Object storage uses so://bucket/key:

homecloud so cp ./file.txt so://media/path/file.txt
homecloud so sync ./dist so://my-website/ --delete

Next¶

Install
Authentication
Pick a command guide above
For libraries in your app, see the SDK