Skip to main content
Version: v0.0.4

Commands

The Makersaurus CLI has 5 commands, however only the "Create New Project" command needs to be invoked directly. It makes more sense to run the remaining commands using the npm scripts set up in package.json.

tip

When using npx you must specify the version of Makersaurus you wish to run. Unless you have a specific reason to use an old version, stick to npx @h2oai/makersaurus@latest

create-new-project​

$ npx @h2oai/makersaurus@latest help create-new-project
Usage: makersaurus create-new-project [options]

Create a new Makersaurus project

Options:
  -o, --out   name of output directory (default: 'documentation')
  -h, --help  display help for command

Here is an example of creating a new project in a custom directory:

$ npx @h2oai/makersaurus@latest create-new-project --out=my-docs

start​

Alias: npm start

$ npx @h2oai/makersaurus@latest help start
Usage: makersaurus start [options]

Serve docs site on http://localhost:3000/. Requires 'docs' folder, 'sidebars.js' and 'makersaurus.config.js' in the root directory

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command

build​

Alias: npm run build

$ npx @h2oai/makersaurus@latest help build
Usage: makersaurus build [options]

Build static site for deployment. Requires 'docs' folder, 'sidebars.js' and 'makersaurus.config.js' in the root directory

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command

serve​

Alias: npm run serve

$ npx @h2oai/makersaurus@latest help serve
Usage: makersaurus serve [options]

Server for testing static builds. Run '@h2oai/makersaurus build' first

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command

deploy​

Alias: npm run deploy.

$ npx @h2oai/makersaurus@latest help deploy
Usage: makersaurus deploy [options]

Deploy static site. Run '@h2oai/makersaurus build' first

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command
tip

The deploy command will fail unless you have permission to push to the repo

Feedback