CLI Reference
Use this reference to check command syntax and options. Start with Deploy Your First Site for a complete workflow.
Command Index
Section titled “Command Index”buzz deploy: Deploy a directory to the serverbuzz list: List sites owned by the signed-in userbuzz delete: Delete a deployed sitebuzz config: View or set configuration (server)buzz url: Show the URL for the current directorybuzz login: Sign in via your browserbuzz logout: Sign out and clear the stored sessionbuzz whoami: Show the current signed-in userbuzz tokens: Manage deployment tokensbuzz tokens list: List your deployment tokensbuzz tokens create: Create a deployment token for a sitebuzz tokens delete: Delete a deployment tokenbuzz domains: Manage custom domainsbuzz domains list: List custom domains and lifecycle statusbuzz domains add: Attach a custom domain to a sitebuzz domains check: Check custom-domain ownership and activationbuzz domains retry: Retry a failed connection transitionbuzz domains cancel-transition: Cancel an active connection transitionbuzz domains remove: Remove a custom domain without changing DNS records
Usage: buzz [options] [command]
Deploy static sites to a Buzz server
Options: -V, --version output the version number -s, --server <url> Buzz server URL (overrides config) -t, --token <token> Session or deployment token (overrides config) -h, --help display help for command
Commands: deploy [options] <directory> Deploy a directory to the server list List sites owned by the signed-in user delete [options] <subdomain> Delete a deployed site config [key] [value] View or set configuration (server) url Show the URL for the current directory login Sign in via your browser logout Sign out and clear the stored session whoami Show the current signed-in user tokens Manage deployment tokens domains Manage custom domains help [command] display help for commandbuzz deploy
Section titled “buzz deploy”Usage: buzz deploy [options] <directory>
Deploy a directory to the server
Options: --subdomain <name> Site name to use as the subdomain -h, --help display help for commandbuzz list
Section titled “buzz list”Usage: buzz list [options]
List sites owned by the signed-in user
Options: -h, --help display help for commandbuzz delete
Section titled “buzz delete”Usage: buzz delete [options] <subdomain>
Delete a deployed site
Options: -y, --yes Skip confirmation prompt -h, --help display help for commandbuzz config
Section titled “buzz config”Usage: buzz config [options] [key] [value]
View or set configuration (server)
Options: -h, --help display help for commandbuzz url
Section titled “buzz url”Usage: buzz url [options]
Show the URL for the current directory
Options: -h, --help display help for commandbuzz login
Section titled “buzz login”Usage: buzz login [options]
Sign in via your browser
Options: -h, --help display help for commandbuzz logout
Section titled “buzz logout”Usage: buzz logout [options]
Sign out and clear the stored session
Options: -h, --help display help for commandbuzz whoami
Section titled “buzz whoami”Usage: buzz whoami [options]
Show the current signed-in user
Options: -h, --help display help for commandbuzz tokens
Section titled “buzz tokens”Usage: buzz tokens [options] [command]
Manage deployment tokens
Options: -h, --help display help for command
Commands: list List your deployment tokens create [options] <site> Create a deployment token for a site delete <token-id> Delete a deployment token help [command] display help for commandbuzz tokens list
Section titled “buzz tokens list”Usage: buzz tokens list [options]
List your deployment tokens
Options: -h, --help display help for commandbuzz tokens create
Section titled “buzz tokens create”Usage: buzz tokens create [options] <site>
Create a deployment token for a site
Options: -n, --name <name> Token name (for identification) -h, --help display help for commandbuzz tokens delete
Section titled “buzz tokens delete”Usage: buzz tokens delete [options] <token-id>
Delete a deployment token
Options: -h, --help display help for commandbuzz domains
Section titled “buzz domains”Usage: buzz domains [options] [command]
Manage custom domains
Options: -h, --help display help for command
Commands: list [site] List custom domains and lifecycle status add <site> <domain> Attach a custom domain to a site check <site> <domain> Check custom-domain ownership and activation retry <site> <domain> Retry a failed connection transition cancel-transition <site> <domain> Cancel an active connection transition remove [options] <site> <domain> Remove a custom domain without changing DNS records help [command] display help for commandbuzz domains list
Section titled “buzz domains list”Usage: buzz domains list [options] [site]
List custom domains and lifecycle status
Options: -h, --help display help for commandbuzz domains add
Section titled “buzz domains add”Usage: buzz domains add [options] <site> <domain>
Attach a custom domain to a site
Options: -h, --help display help for commandbuzz domains check
Section titled “buzz domains check”Usage: buzz domains check [options] <site> <domain>
Check custom-domain ownership and activation
Options: -h, --help display help for commandbuzz domains retry
Section titled “buzz domains retry”Usage: buzz domains retry [options] <site> <domain>
Retry a failed connection transition
Options: -h, --help display help for commandbuzz domains cancel-transition
Section titled “buzz domains cancel-transition”Usage: buzz domains cancel-transition [options] <site> <domain>
Cancel an active connection transition
Options: -h, --help display help for commandbuzz domains remove
Section titled “buzz domains remove”Usage: buzz domains remove [options] <site> <domain>
Remove a custom domain without changing DNS records
Options: -y, --yes Skip confirmation prompt -h, --help display help for command