Hyas CLI

Hyas command line tool.

$ hyas -h
Hyas command line tool

Usage: hyas <command> [options]

Commands:
  create [dir]   Create a new Hyas project
  start          Start local development server
  build          Build production website
  add [file]     Add content file
  clean          Delete temporary directories
  lint [source]  Check for errors
  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 [options]

Examples#

Create a Hyas project#

Create a Hyas project in my-hyas-site using the starter theme:

hyas create my-hyas-site

Create a Hyas project in my-hyas-site using the child-theme:

hyas create my-hyas-site --child

Create a Doks project#

Create a Doks project in my-hyas-site using the starter theme:

hyas create my-hyas-site --theme=doks

Create a Doks project in my-hyas-site using the child-theme:

hyas create my-hyas-site --theme=doks --child

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.4.1 → 0.4.2
Run npm i -g @hyas/cli to update

Edit this page on GitHub