hyperctl deploy

hyperctl deploy command

Overview

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

Usage

 1$ hyperctl deploy -h
 2Deployment management tools
 3
 4Usage:
 5	hyperctl deploy [options]
 6
 7Options:
 8	-c, --config       Path to the website configuration file. (required) (env: HYPER_CONFIG) (default: site.yaml)
 9	-e, --environment  Deployment environment to use from site.environments. (env: HYPER_ENVIRONMENT)
10	    --providers    Comma-separated provider names to deploy from site.providers. (env: HYPER_PROVIDERS)
11	    --incremental  Switch from full-site deployment mode to incremental deployment mode. Requires --page.
12	-p, --page         Path to the page index file for incremental deployments.
13	    --content-dir  Relative path to the content directory to use for the build (overwrites site.config.content_dir). (env: HYPER_CONTENT_DIR)
14	    --data-dir     Relative path to the data directory to use for the build (overwrites site.config.data_dir). (env: HYPER_DATA_DIR)
15	    --static-dir   Relative path to the static directory to use for the build (overwrites site.config.static_dir). (env: HYPER_STATIC_DIR)
16	    --theme        Relative path to theme config to use for the build (overwrites site.config.theme). (env: HYPER_THEME)
17	    --data-file    Relative path to write an optional build data JSON file (e.g. build.json).
18	    --log-file     Relative path to write an optional build log file (e.g. build.log).
19	-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"

--providers

Comma-separated provider names to deploy from site.providers.

1hyperctl deploy --providers "r2, github-pages"

--environment

Named environment to deploy to.

1hyperctl deploy --environment production

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