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

nova <command> <subcommand> [option]
  • Options are recommended. It is recommended to type the option (flags / switches) you want, like --all or -a. No assumptions. This helps you learn the command faster.
  • Build it step by step. Start with nova. Add the command. Add the subcommand if needed. 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.

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 <subcommand> or nova gen <subcommand>.

AWS

SubcommandWhat It Does
aws-amplifyCreate a amplify.yml file for AWS Amplify deployments

Cloudflare

SubcommandWhat It Does
cloudflare-workersCreate a wrangler.toml file for Cloudflare Workers deployments

Docker

SubcommandWhat It Does
docker-composeCreate a docker-compose.yml file for Docker builds
docker-fileCreate a Dockerfile for Docker builds

Docusaurus

SubcommandWhat It Does
docusaurus-configCreate a docusaurus.config.ts file for Docusaurus configuration

GitHub

SubcommandWhat It Does
github-fundingCreate a ./github/FUNDING.yml file for GitHub to enable sponsor links
github-issue-templateCreate a ./github/ISSUE_TEMPLATE directory for GitHub to create issue templates
github-workflowsCreate a ./github/workflows directory for GitHub to enable CI/CD automation

Must-Haves

SubcommandWhat It Does
must-haves-dotenvCreate a .env file for managing local environment secrets across your project
must-haves-editorconfigCreate a .editorconfig file for managing consistent coding styles
must-haves-gitignoreCreate a .gitignore file for managing files that should be excluded from Git commits
must-haves-licenseCreate a LICENSE file for managing project license agreements
must-haves-post-installCreate a post-install.ts file for expanding on post-install controls
must-haves-read-meCreate a baseline README.md file for your project

Next.js

SubcommandWhat It Does
nextjs-configCreate a next.config.mjs file for Next.js configuration

Vite

SubcommandWhat It Does
vite-configCreate a vite.config.mjs file for Vite configuration

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 package-json <subcommand> or nova rcp package-json <subcommand>.

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 for popular builders and tools. All scaffolds are built as a monorepo and include Docusaurus built in.

info

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

SubcommandProject Type
nextjsNext.js

Utilities

Tools for diagnostics, quick checks, and development helpers.

info

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

SubcommandShorthandWhat It Does
changeloglogRecord changes and release versioned changelogs
initializeinitGenerate a new nova.config.json configuration file for use with nova generate and nova recipe commands
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.