Quick Start

Install the hyperctl CLI tool.

Visit the HyperTemplates downloads page to see all of the available hyperctl for your platform.

• MacOS

  1curl -LO https://hypertemplates.net/downloads/hyperctl_0.14.2_darwin_universal.tar.gz
  2tar -xzf hyperctl_0.14.2_darwin_universal.tar.gz
  3chmod +x hyperctl
  4sudo mv hyperctl /usr/local/bin/
  5hyperctl # run hyperctl to verify the installation and see the version number
  

• Linux

  1curl -LO https://hypertemplates.net/downloads/hyperctl_0.14.2_linux_amd64.tar.gz
  2tar -xzf hyperctl_0.14.2_linux_amd64.tar.gz
  3chmod +x hyperctl
  4sudo mv hyperctl /usr/local/bin/
  5hyperctl # run hyperctl to verify the installation and see the version number
  

• Windows (coming soon)

  If you're interested in trying out beta releases of HyperTemplates for Windows, please join the community and check out hyperctl for Windows.

Start a new HyperTemplates project with the hyperctl new website command.

1hyperctl new website -b "https://acmeinc.com" -t "Acme Inc" acme-website
2cd acme-website

The hyperctl new website command provides some basic scaffolding for a new website, including your site.yaml configuration file, a landing page, some example layout templates, and more.

Feel free to explore the generated files in your text editor, or move on to the next step to start the development server and view your new website in a browser.

Start the HyperTemplates development server with the hyperctl server command.

1hyperctl server --config site.yaml

Now open your browser to http://localhost:8080 to view your new HyperTemplates website!

Voila! You now have a basic HyperTemplates website up and running, and ready for you to customize and build upon.