Install Hyas with the Automatic CLI

Ready to install Hyas? Follow this guide to using the create hyas CLI to get started.

Prerequisites

Node.js - v16.17.0 or higher.
Text editor - We recommend VS Code with the Hugo Language and Syntax Support extension.
Terminal - Hyas is accessed through its command-line interface (CLI).

Installation

create-hyas is the fastest way to start a new Hyas project from scratch. It will walk you through every step of setting up your new Hyas project. It allows you to choose from a few different official starter templates.

1. Run the Setup Wizard

Run the following command in your terminal to start our handy install wizard:

npm create hyas@latest

pnpm create hyas@latest

yarn create hyas

You can run create-hyas anywhere on your machine, so there’s no need to create a new empty directory for your project before you begin. If you don’t have an empty directory yet for your new project, the wizard will help create one for you automatically.

If all goes well, you should see a “Done” message followed by some “Next steps”.

2. Install dependencies

cd into your new project directory and install your dependencies before continuing.

npm install

pnpm install

yarn install

3. Start Hyas ✨

Hyas uses the Hugo development server that has everything you need for project development. The dev command will start the local development server so that you can see your new website in action for the very first time.

Use your favorite package manager to run this command and start the Hugo development server.

npm run dev

pnpm run dev

yarn run dev

If all goes well, Hyas should now be serving your project on http://localhost:1313!

The Hugo server will listen for live file changes in your project directory, so you will not need to restart the server as you make changes during development.

If you aren’t able to open your project in the browser, go back to the terminal where you ran the dev command and look to see if an error occurred, or if your project is being served at a different URL than the one linked to above.

Starter Templates

You can also start a new Hyas project based on an official example by passing a --template argument to the create hyas command or by using a tool like degit to scaffold your project with the main branch of any GitHub repository.

Official

Create a new project with an official example — for example with Doks:

# Syntax: npm create hyas@latest -- --template <example-name>
npm create hyas@latest -- --template doks

# Syntax: pnpm create hyas@latest --template <example-name>
pnpm create hyas@latest --template doks

# Syntax: yarn create hyas --template <example-name>
yarn create hyas@latest --template doks

Community

Create a new project based on a GitHub repository’s main branch

# Syntax: npx degit <user/repo> [project-directory]
npx degit h-enk/simply-cyan my-hyas-project

# Syntax: pnpm dlx degit <user/repo> [project-directory]
pnpm dlx degit h-enk/simply-cyan my-hyas-project

# Syntax: yarn dlx degit <user/repo> [project-directory]
yarn dlx degit h-enk/simply-cyan my-hyas-project

Explore our themes and starters showcase where you can browse themes for blogs, portfolios, documentation, landing pages, and more! Or, search on GitHub for even more starter projects.

Next Steps

Success! You are now ready to start building with Hyas! 🥳

Here are a few topics that we recommend exploring next. You can read them in any order. You can even leave our documentation for a bit and go play in your new Hyas project codebase, coming back here whenever you run into trouble or have a question.

Add a framework: Learn how to extend Hyas with support for React, Svelte, Tailwind and more in our Integrations guide.
Deploy your site: Learn how to build and deploy a Hyas project to the web in our Deployment guide.
Understand your codebase: Learn more about Hyas’ project structure in our Project Structure guide.