hyperctl theme package

hyperctl theme package command

Overview

The hyperctl theme package command installs themes.

Usage

 1$ hyperctl theme package -h
 2Package a theme into a zip archive.
 3
 4Usage:
 5        hyperctl theme package [options]
 6
 7Options:
 8        -c, --config  Path to the website configuration file. (required) (env: HYPER_CONFIG) (default: site.yaml)
 9        -t, --theme   Path to the theme configuration file. (required) (env: HYPER_THEME) (default: theme.json)
10        -f, --file    Output file path for the theme package (zip archive).
11        -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"

-t, --theme

Path to the theme configuration file (theme.json).

Defaults to the HYPER_THEME environment variable, if set.

To configure a default, use the export command.

1export HYPER_THEME="theme/theme.json"

-f, --file

Path to the theme archive file to be created (e.g. mywebsite-theme-v0.1.0.zip).

Defaults to a file named <Name>-v<Version>.zip using the configured website.theme.name and website.theme.version values. If -f or --file is not provided, and no theme name and version is configured, hyperctl theme package will generate a theme archive file named Untitled-v0.0.0.zip.