Skip to content

gethyas/create-hyas

Repository files navigation

create-hyas

Official CLI for scaffolding a new Hyas project.

Status

npm (scoped)

Requirements

How to use

npm

npm create hyas@latest

Yarn

yarn create hyas

pnpm

pnpm create hyas@latest

Then follow the prompts!

Options

You can also directly specify the project name and the template you want to use via additional command line options. Use . for the project name to scaffold in the current directory. For example, to scaffold a Doks project, run:

npm

npm create hyas@latest my-doks-project -- --template doks

Yarn

yarn create hyas my-doks-project --template doks

pnpm

pnpm create hyas@latest my-doks-project --template doks

Templates

Currently supported template presets include:

  • doks
  • bolt
  • tailwindcss-starter
  • tailwindcss-starter-rec
  • bootstrap-starter
  • bootstrap-starter-rec
  • basic-starter
  • basic-starter-rec

Variants

The -rec variants include the recommended integrations, currently:

Community templates

You can use a tool like degit to scaffold your project with one of the community templates.

npm

npx degit user/repo my-project

Yarn

yarn dlx degit user/repo my-project

pnpm

pnpm dlx degit user/repo my-project

Credits

This npm package is based on: