Hyas CLI

Hyas command line tool.

Hyas command line tool

Usage: hyas <command> [options]

Commands:
  create <dir> [theme]  Create a new Hyas project
  start                 Start local development server
  build                 Build production website
  clean                 Delete temporary directories
  check                 Check local environment

Options:
  -h, --help     Show help for command                                 [boolean]
  -v, --version  Show @hyas/cli version                                [boolean]

Learn more:
  Use 'hyas <command> --help' for more information about a command.
  Read the manual at https://gethyas.com/hyas-cli

Installation

Install the Hyas CLI globally:

npm install -g @hyas/cli

npx

Or use npx:

npx @hyas/cli <command> [options]

Usage

hyas <command> [options]

Commands

Create

Create a new Hyas project:

hyas create <dir> [theme]
ArgumentsDescription
dirName of the directory to create the project in
themeName of the Hyas theme to use
-s, --starterUse starter theme (default: use child theme)

Examples

Create a Hyas site

Using the child theme:

hyas create my-hyas-site

Using the starter theme:

hyas create my-hyas-site -s
Create a Doks site

Using the child theme:

hyas create my-doks-site doks

Using the starter theme:

hyas create my-doks-site doks -s

Start

Start local development server:

hyas start

Build

Build production website:

hyas build

Clean

Delete temporary directories:

hyas clean

Check

Check local environment:

hyas check

Options

-h, –help

Show help for command.

-v, –version

Show @hyas/cli version.

Update

You’ll get notified when an update is available:

Update available 0.3.8 → 0.3.9
Run npm i -g @hyas/cli to update

Edit this page on GitHub