Install Hyas with the Automatic CLI
Ready to install Hyas? Follow this guide to using the
create hyas CLI to get started.
- Node.js -
- Text editor - We recommend VS Code with the Hugo Language and Syntax Support extension.
- Terminal - Hyas is accessed through its command-line interface (CLI).
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:
# create a new project with npm npm create hyas@latest
# create a new project with pnpm pnpm create hyas@latest
# create a new project with yarn 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.
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.
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.
# create a new project with an official example npm create hyas@latest -- --template <example-name> # create a new project based on a GitHub repository's main branch npx degit <username/repo> [project-directory]
# create a new project with an official example pnpm create hyas@latest --template <example-name> # create a new project based on a GitHub repository's main branch pnpm dlx degit <username/repo> [project-directory]
# create a new project with an official example yarn create hyas --template <example-name> # create a new project based on a GitHub repository's main branch yarn dlx degit <username/repo> [project-directory]
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.