CLI reference

Every command answers --help; this page is that output, generated from the CLI at build time. Success prints exactly one line on stdout — the URL — or one JSON object with --json; everything else goes to stderr, and a failure exits non-zero.

handbill

DESCRIPTION
  Hand someone a page: publish one self-contained HTML file, or a markdown file rendered to one, at an unguessable, immutable URL.

USAGE
  handbill <subcommand> [flags] <file>

ARGUMENTS
  file string    HTML or markdown file to publish, or - to read stdin

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout
  --markdown           Render the input as markdown, whatever it is named — needed for stdin
  --open               Open the printed URL in the default browser

GLOBAL FLAGS
  --help, -h                                                          Show help information
  --version, -v                                                       Show version information
  --wizard                                                            Start wizard mode for a command
  --completions <bash|zsh|fish|sh>                                    Print shell completion script (choices: bash, zsh, fish, sh)
  --log-level <all|trace|debug|info|warn|warning|error|fatal|none>    Sets the minimum log level (choices: all, trace, debug, info, warn, warning, error, fatal, none)

SUBCOMMANDS
  list           List the pages you have published, newest first.
  remove         Unpublish a page. Idempotent: removing it twice is not an error.
  alias          Point a name at a page: https://<name>.<zone> serves it until the name is pointed elsewhere. Names are guessable, and the deployment has to switch aliases on.
  doctor         Check the configuration, the endpoint, the token and the wildcard certificate.
  completions    Print a shell completion script for bash, zsh or fish.
EXAMPLES
  # Publish a file and print its URL
  handbill plan.html

  # Render markdown to a page and publish that
  handbill notes.md

  # Publish markdown from stdin
  handbill - --markdown

  # Publish, then open the URL in the browser
  handbill plan.html --open

  # Print { hash, url, created } instead
  handbill plan.html --json

handbill list

DESCRIPTION
  List the pages you have published, newest first.

USAGE
  handbill list [flags]

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout

handbill remove

DESCRIPTION
  Unpublish a page. Idempotent: removing it twice is not an error.

USAGE
  handbill remove [flags] <target>

ARGUMENTS
  target string    The URL of a published page, or its 12-character hash

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout

handbill alias

DESCRIPTION
  Point a name at a page: https://<name>.<zone> serves it until the name is pointed elsewhere. Names are guessable, and the deployment has to switch aliases on.

USAGE
  handbill alias <subcommand> [flags] <name> <target>

ARGUMENTS
  name string      The name, one DNS label: served at https://<name>.<zone>
  target string    The URL of a published page, or its 12-character hash

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout
  --open               Open the printed URL in the default browser

SUBCOMMANDS
  remove    Remove an alias. Idempotent, and the page it pointed at stays published.
  list      List your aliases by name: the URL and the hash it points at.
EXAMPLES
  # plan.example.dev now serves that page
  handbill alias plan https://a3f9c1d4e2b8.example.dev

  # The same by hash, then open it
  handbill alias plan a3f9c1d4e2b8 --open

  # Every alias: its URL and the hash it points at
  handbill alias list

  # The name stops answering; the page stays
  handbill alias remove plan

handbill alias remove

DESCRIPTION
  Remove an alias. Idempotent, and the page it pointed at stays published.

USAGE
  handbill alias remove [flags] <name>

ARGUMENTS
  name string    The alias to remove

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout

handbill alias list

DESCRIPTION
  List your aliases by name: the URL and the hash it points at.

USAGE
  handbill alias list [flags]

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout

handbill doctor

DESCRIPTION
  Check the configuration, the endpoint, the token and the wildcard certificate.

USAGE
  handbill doctor [flags]

FLAGS
  --endpoint string    Base URL of the deployment; beats HANDBILL_ENDPOINT and the config file
  --json               Print the result as one JSON object on stdout

handbill completions

DESCRIPTION
  Print a shell completion script for bash, zsh or fish.

USAGE
  handbill completions [flags] <shell>

ARGUMENTS
  shell choice

FLAGS
  --json    Print the result as one JSON object on stdout