Skip to content
Buzz

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

Section titled “buzz”
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


Sites:
  deploy [options] <directory>  Deploy a directory to the server
  deployments                   List deployments or make one live
  list                          List sites owned by the signed-in user
  url                           Show the URL for the current directory
  delete [options] <site>       Delete a deployed site


Site settings:
  access                        Show or change who can view a site
  domains                       Manage custom domains


Automation:
  tokens                        Manage deployment tokens


Account:
  login                         Sign in via your browser
  logout                        Sign out and clear the stored session
  whoami                        Show the current signed-in user
  config [key] [value]          View or set configuration (server)


Commands:
  help [command]                display help for command

buzz deploy

Section titled “buzz deploy”
Usage: buzz deploy [options] <directory>


Deploy a directory to the server


Options:
  --site <name>  Site to deploy to (created if needed)
  --private      Publish the site so only you can view it
  -h, --help     display help for command

buzz deployments

Section titled “buzz deployments”
Usage: buzz deployments [options] [command]


List deployments or make one live


Options:
  -h, --help                         display help for command


Commands:
  list [options]                     List deployments for a site
  use [options] <deployment-number>  Make a deployment live for a site
  help [command]                     display help for command

buzz deployments list

Section titled “buzz deployments list”
Usage: buzz deployments list [options]


List deployments for a site


Options:
  --site <site>  Site name (defaults to the current CNAME)
  -h, --help     display help for command

buzz deployments use

Section titled “buzz deployments use”
Usage: buzz deployments use [options] <deployment-number>


Make a deployment live for a site


Options:
  --site <site>  Site name (defaults to the current CNAME)
  -h, --help     display help for command

buzz list

Section titled “buzz list”
Usage: buzz list [options]


List sites owned by the signed-in user


Options:
  -h, --help  display help for command

buzz url

Section titled “buzz url”
Usage: buzz url [options]


Show the URL for the current directory


Options:
  -h, --help  display help for command

buzz delete

Section titled “buzz delete”
Usage: buzz delete [options] <site>


Delete a deployed site


Options:
  -y, --yes   Skip confirmation prompt
  -h, --help  display help for command

buzz access

Section titled “buzz access”
Usage: buzz access [options] [command]


Show or change who can view a site


Options:
  -h, --help         display help for command


Commands:
  status [options]   Show who can view this site (default)
  private [options]  Let only the site owner view this site
  public [options]   Let anyone view this site
  help [command]     display help for command

buzz access status

Section titled “buzz access status”
Usage: buzz access status [options]


Show who can view this site (default)


Options:
  --site <site>  Site name (defaults to the current CNAME)
  -h, --help     display help for command

buzz access private

Section titled “buzz access private”
Usage: buzz access private [options]


Let only the site owner view this site


Options:
  --site <site>  Site name (defaults to the current CNAME)
  -h, --help     display help for command

buzz access public

Section titled “buzz access public”
Usage: buzz access public [options]


Let anyone view this site


Options:
  --site <site>  Site name (defaults to the current CNAME)
  -y, --yes      Skip confirmation prompt
  -h, --help     display help for command

buzz 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 command

buzz 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 command

buzz 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 command

buzz 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 command

buzz 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 command

buzz 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 command

buzz 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

buzz 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 command

buzz tokens list

Section titled “buzz tokens list”
Usage: buzz tokens list [options]


List your deployment tokens


Options:
  -h, --help  display help for command

buzz 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 command

buzz tokens delete

Section titled “buzz tokens delete”
Usage: buzz tokens delete [options] <token-id>


Delete a deployment token


Options:
  -h, --help  display help for command

buzz login

Section titled “buzz login”
Usage: buzz login [options]


Sign in via your browser


Options:
  -h, --help  display help for command

buzz logout

Section titled “buzz logout”
Usage: buzz logout [options]


Sign out and clear the stored session


Options:
  -h, --help  display help for command

buzz whoami

Section titled “buzz whoami”
Usage: buzz whoami [options]


Show the current signed-in user


Options:
  -h, --help  display help for command

buzz config

Section titled “buzz config”
Usage: buzz config [options] [key] [value]


View or set configuration (server)


Options:
  -h, --help  display help for command