hyperctl generate

hyperctl generate command

Overview

The hyperctl generate command performs an incremental build.

Usage

 1Generate a single page build from a HyperTemplate.
 2
 3Usage:
 4        hyperctl generate [options] [content]
 5
 6Options:
 7        -c, --config  path to the website configuration file. (required) (env: HYPER_CONFIG) (default: site.yaml)
 8        -p, --page    Path to the content index file. (required)
 9        -i, --id      Identifier to use for the build (useful for retrying builds). (default: a45e1b1e-39c2-4326-9fcf-e6a15e42ff98)
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"

-p, --page

The path to the page index file to use for the build.

The --page argument is required to perform an incremental build.

-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.