Skip to main content

CLI Reference

The Nova CLI lets you generate files, apply recipes, scaffold projects, and run utilities.

Step by step

Not sure what to type? Build the command one section at a time.

Start with nova, then the command and subcommand (if available), and finally the options like --all or -a. Each step shows inline guidance so you don't wonder what to do next.

Get Started

  • Options are recommended — Type the option (flags / switches) you want, like --all or -a. This helps you learn the command faster.
  • Build it step by step — Start with nova, add the command and subcommand, then finish with options like --all or -a. Repeat until it feels natural.

Commands

All commands below show a help screen when run with the --help or -h option, so you can explore safely and avoid accidental runs.

Mix and match

You can freely combine full names and shorthands in the same command. For example, nova generate must lic and nova gen must-haves license both work the same way.

Generators

Create semi-tailored versions of supported vendor and project essentials, populated with values from nova.config.json at the monorepo root.

info

All commands in "Generators" are shaped as nova generate <category> <subcommand> or nova gen <alias> <shorthand>.

GitHub

Category: github · Alias: gh

SubcommandShorthandWhat It Does
fundingCreate a .github/FUNDING.yml file for GitHub sponsor links.
issue-templateissueCreate .github/ISSUE_TEMPLATE files for GitHub issue forms.
workflowsCreate .github/workflows files for GitHub CI/CD automation.

Must-Haves

Category: must-haves · Alias: must

SubcommandShorthandWhat It Does
agent-conventionsagentCreate agent convention files for coding assistants.
dotenvenvCreate .env and .env.sample files for environment secrets.
editorconfigCreate a .editorconfig file for consistent coding styles.
gitignoreCreate a .gitignore file for excluding files from Git commits.
licenselicCreate a LICENSE file for project license agreements.
read-mereadCreate a baseline README.md file for your project.

Recipes

Apply scripted edits that automate routine maintenance, using values from nova.config.json at the monorepo root.

info

All commands in "Recipes" are shaped as nova recipe <category> <subcommand> or nova rcp <alias> <shorthand>.

package.json

Category: package-json · Alias: pkg

SubcommandShorthandWhat It Does
cleanupcleanRemove unsupported keys and reorder remaining keys in workspace package.json files.
normalize-artifactsnorm-artNormalize files, bin, man, directories, private, and publishConfig in workspace package.json files.
normalize-bundlernorm-bunNormalize types, module, sideEffects, and esnext bundler fields in workspace package.json files.
normalize-dependenciesnorm-depNormalize dependency fields and optionally pin versions in workspace package.json files.
normalize-modulesnorm-modNormalize exports, main, type, browser, and imports fields in workspace package.json files.
normalize-toolingnorm-toolNormalize scripts, gypfile, config, and workspaces in workspace package.json files.
sync-environmentsync-envSync engines, os, cpu, libc, devEngines, and packageManager in workspace package.json files.
sync-identitysync-idSync name, version, description, keywords, and license to workspace package.json files.
sync-ownershipsync-ownSync homepage, bugs, author, contributors, funding, and repository to workspace package.json files.

Scaffolding

Bootstrap full project starters as monorepo workspaces. Each scaffold creates a ready-to-use workspace with all necessary config files, dependencies, and build setup.

info

All commands in "Scaffolding" are shaped as nova scaffold <category> <subcommand> or nova scaf <alias> <shorthand>.

App

Category: app · Alias: none

SubcommandShorthandWhat It Does
expressjsexpressScaffold an Express.js workspace.
nextjsnextScaffold a Next.js workspace.
viteScaffold a Vite workspace.
workersScaffold a Cloudflare Workers workspace.

Docs

Category: docs · Alias: none

SubcommandShorthandWhat It Does
docusaurusScaffold a Docusaurus documentation workspace.

Starter

Category: starter · Alias: start

SubcommandShorthandWhat It Does
baseScaffold a base monorepo project without a framework workspace.

Utilities

Tools for diagnostics, quick checks, and development helpers.

info

All commands in "Utilities" are shaped as nova utility <subcommand> or nova util <shorthand>.

SubcommandShorthandWhat It Does
changeloglogRecord changes and release versioned changelogs.
initializeinitGenerate a new nova.config.json configuration file for this project.
run-recipesrun-rcpRun all enabled recipes and finalize workspace package.json files.
run-scriptsrun-scrRun package.json scripts by pattern in sequential or parallel mode.
transpilexpileTranspile TypeScript with filtered diagnostics, emitting compiled output for project-owned files.
type-checktype-chkRun full TypeScript type checking scoped to project-owned files, filtering out third-party diagnostics.
versionverGenerate a Markdown-ready snapshot of your development stack versions (e.g., node --version).

Troubleshooting

Exit Codes

CodeMeaningResult
0SuccessResponse of the executed command.
1ErrorHelp text displayed.

Quick Fixes

  • Prefer explicit command, subcommands, and options for clarity, fewer mistakes, and predictable behavior. For example, nova utility version --all instead of the alternate variants.