Template: header
Template: markdown


The @amagaki/amagaki package provides a command line interface (CLI) program. All commands should be invoked from your pod's root directory. You can invoke the amagaki command easily using npx.

There are two commands:

  • build
  • serve


npx amagaki build

The build command is used to build the HTML and collect static file dependencies for your site.

When building the site, Amagaki will walk all content, generate routes, render HTML, and copy static files to the specified output paths. The deployed fileset will contain everything needed to deploy your static site.


npx amagaki serve

The serve command starts the Amagaki dev server. The Amagaki dev server builds pages on the fly at request time (and caches the result, until the underlying filesystem is changed).

Template: footer