hyperctl build

hyperctl build command

Overview

The hyperctl build command is used to perform full-site and incremental builds.

Usage

 1$ hyperctl build -h
 2Build management tools
 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. (default: c858bf52-01dc-4f5c-8236-de95dae708dc)
10	    --incremental  Switch from full-site build mode to incremental build mode. Requires --page.
11	-p, --page         Path to the page index file for incremental builds.
12	    --content-dir  Relative path to the content directory to use for the build (overwrites site.config.content_dir). (env: HYPER_CONTENT_DIR)
13	    --data-dir     Relative path to the data directory to use for the build (overwrites site.config.data_dir). (env: HYPER_DATA_DIR)
14	    --static-dir   Relative path to the static directory to use for the build (overwrites site.config.static_dir). (env: HYPER_STATIC_DIR)
15	    --theme        Relative path to theme config to use for the build (overwrites site.config.theme). (env: HYPER_THEME)
16	    --data-file    Relative path to write an optional build data JSON file (e.g. build.json).
17	    --log-file     Relative path to write an optional build log file (e.g. build.log).
18	-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.

--incremental

Perform an incremental build.

NOTE: the --page argument is required for --incremental builds.

NEW! the --log-file flag is available in hyperctl version 0.22.0 and later.

-p, --page

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

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

NEW! the --log-file flag is available in hyperctl version 0.22.0 and later.

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

--data-file

Relative path to write an optional build data JSON file (e.g. build.json).

NOTE: if --data-file is set, a [.deploymentignore file] will be generated with the data file name.

NEW! the --data-file flag is available in hyperctl version 0.22.0 and later.

--log-file

Relative path to write an optional build log file (e.g. build.log).

NOTE: if --log-file is set, a [.deploymentignore file] will be generated with the log file name.

NEW! the --log-file flag is available in hyperctl version 0.22.0 and later.