hyperctl build

hyperctl build command

Overview

The hyperctl build command is used to perform full website builds.

Usage

 1$ hyperctl build -h
 2Build a static site from HyperTemplates.
 3
 4Usage:
 5        hyperctl build [options]
 6
 7Options:
 8        -c, --config  path to the website configuration file. (required) (env: HYPER_CONFIG) (default: site.yaml)
 9        -i, --id      Identifier to use for the build (useful for retrying builds). (default: 2fa8f1d8-e2ac-47f8-bc59-aff03eb48ca8)
10        -h, --help    Display help information.

Options

-c, --config

Path to the website configuration file (site.yaml or site.json).

Defaults to the HYPER_CONFIG environment variable, if set.

To configure a default, use the export command.

1export HYPER_CONFIG="site.yaml"

-i, --id

The identifier to use for the build.

Defaults to a randomly generated UUIDv4 string.

WARNING: providing a --id can cause hyperctl build to overwite an existing build. This can be useful in some cases (e.g. when using an external HTTP server to serve a specific build). In most cases it is unecessary to provide a --id, and in some cases it can cause confusion.