hyperctl generate

hyperctl generate command

Overview

The hyperctl generate command performs an incremental build.

Usage

 1$ hyperctl generate -h
 2Perform an incremental build of a single page and its associated contents.
 3
 4Usage:
 5        hyperctl generate [options] [content]
 6
 7Options:
 8        -c, --config       Path to the website configuration file. (required) (env: HYPER_CONFIG)
 9        -p, --page         Path to the page index file. (required)
10        -i, --id           Identifier to use for the build. (default: e96001dc-5c38-4e59-bd96-ce5c8d9afe93)
11            --content-dir  Relative path to the content directory to use for the build (overwrites site.config.content_dir). (env: HYPER_CONTENT_DIR)
12            --data-dir     Relative path to the data directory to use for the build (overwrites site.config.data_dir). (env: HYPER_DATA_DIR)
13            --static-dir   Relative path to the static directory to use for the build (overwrites site.config.static_dir). (env: HYPER_STATIC_DIR)
14            --theme        Relative path to theme config to use for the build (overwrites site.config.theme). (env: HYPER_THEME)
15        -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.

--content-dir

Relative path to the content directory to use for the build (overwrites site.config.content_dir). Uses the HYPER_CONTENT_DIR environment variable as a default value, if set.

NEW! the --content-dir flag is available in hyperctl version 0.17.0 and later.

--data-dir

Relative path to the data directory to use for the build (overwrites site.config.data_dir). Uses the HYPER_DATA_DIR environment variable as a default value, if set.

NEW! the --data-dir flag is available in hyperctl version 0.17.0 and later.

--static-dir

Relative path to the static directory to use for the build (overwrites site.config.static_dir). Uses the HYPER_STATIC_DIR environment variable as a default value, if set.

NEW! the --static-dir flag is available in hyperctl version 0.17.0 and later.

--theme

Relative path to theme config to use for the build (overwrites site.config.theme). Uses the HYPER_THEME environment variable as a default value, if set.

NEW! the --theme flag is available in hyperctl version 0.17.0 and later.