hyperctl deploy complete command

Overview


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

NOTE: files are only written to the provider on successful build.

Usage


 1$ hyperctl deploy complete --help
 2Deploy a complete build.
 3
 4Usage:
 5	hyperctl deploy complete [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	    --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"
--providers
Comma-separated provider names to deploy from site.providers
1  
--environment
Named environment to deploy to.
--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.

💬 Join the community

Stay up-to-date with the latest releases and other news from the Team behind HyperTemplates. Ask the developers questions, get help from the community, and share your creations! 🎨