Commands

You can use the scripts in package.json to create new content and develop, format, build, and preview your project from a terminal window.

package.json scripts

The following scripts for the most common commands (create, dev, format, build, and preview) are added for you automatically when you create a project using the create hyas wizard.

When you follow the instructions to install Hyas manually, you are instructed to add these scripts yourself. You can also add more scripts to this list manually for any commands you use frequently.

package.json

{
  "scripts": {
    "create": "hugo new",
    "dev": "hugo server --disableFastRender --noHTTPCache",
    "format": "prettier **/** -w -c",
    "build": "hugo --minify --gc",
    "preview": "vite preview --outDir public"
  }
}

You will often use these commands, or the scripts that run them, without any flags. Add flags to the command when you want to customize the command’s behavior. For example, you may wish to start the development server on a different port, or build your site with verbose logs for debugging.

npm

# Run the dev server on port 3000 using the `dev` script in `package.json`
npm run dev -- --port 3000

# Build your site with verbose logs using the `build` script in `package.json`
npm run build -- --verbose

pnpm

# run the dev server on port 3000 using the `dev` script in `package.json`
pnpm dev --port 3000

# build your site with verbose logs using the `build` script in `package.json`
pnpm build --verbose

Yarn

# run the dev server on port 3000 using the `dev` script in `package.json`
yarn dev --port 3000

# build your site with verbose logs using the `build` script in `package.json`
yarn build --verbose

Note

The extra -- before any flag is necessary for npm to pass your flags to the script.

Note

You can find the available flags for a command on the command’s linked script page below.

create

Run the following command in your terminal to create new content:

npm

# npm run create [path] [flags]
npm run create

pnpm

# pnpm run create [path] [flags]
pnpm run create

Yarn

# yarn run create [path] [flags]
yarn run create

For example, create an about page in the content directory of your project:

npm

npm run create about.md

pnpm

pnpm run create about.md

Yarn

yarn run create about.md

dev

Run the following command in your terminal to start the Hugo development server:

npm

# npm run dev [flags]
npm run dev

pnpm

# pnpm dev [flags]
pnpm dev

Yarn

# yarn dev [flags]
yarn dev

format

Run the following command in your terminal to run the Prettier code formatter:

npm

# npm run format [flags]
npm run format

pnpm

# pnpm format [flags]
pnpm format

Yarn

# yarn format [flags]
yarn format

build

Run the following command in your terminal to create a production build:

npm

# npm run build [flags]
npm run build

pnpm

# pnpm build [flags]
pnpm build

Yarn

# yarn build [flags]
yarn build

preview

Run the following command in your terminal to locally preview the production build:

npm

# npm run preview [flags]
npm run preview

pnpm

# pnpm preview [flags]
pnpm preview

Yarn

# yarn preview [flags]
yarn preview