hyperctl deploy

hyperctl deploy command

Overview

The hyperctl deploy command performs a full website build and deploys the resulting build output to the configured provider.

Usage

 1$ hyperctl deploy -h
 2Deploy a static site build to the configured provider.
 3
 4Usage:
 5        hyperctl deploy [options]
 6
 7Options:
 8        -c, --config       Path to the website configuration file. (required) (env: HYPER_CONFIG)
 9            --content-dir  Relative path to the content directory to use for the build (overwrites site.config.content_dir). (env: HYPER_CONTENT_DIR)
10            --data-dir     Relative path to the data directory to use for the build (overwrites site.config.data_dir). (env: HYPER_DATA_DIR)
11            --static-dir   Relative path to the static directory to use for the build (overwrites site.config.static_dir). (env: HYPER_STATIC_DIR)
12            --theme        Relative path to theme config to use for the build (overwrites site.config.theme). (env: HYPER_THEME)
13        -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"

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