Skip to main content

Setup and Configure

Nova supports three starting paths. Use the runner for a one-off, install into system, or install into project for presets and toolkits you can commit with.

Requirements

  • Node.js LTS
  • npm for the bootstrap commands shown on this page
  • TypeScript 6.0.3 for projects that use Nova's TSConfig presets or compiler-backed utilities

Nova-managed projects may select npm, pnpm, or Yarn through an exact root packageManager descriptor. Corepack activates that pinned client when Nova-generated publish workflows run. See Workspace Rules for the accepted values and why the field belongs only at the project root.

Quick Check

Run this command below to check the installed versions of your Node.js, package managers, operating system, installed browsers, and other dev tools directly:

bash
npx --yes @cbnventures/nova@latest utility version

Choose Your Path

Choose Run once (npx) to try Nova or make a one-off change, Install into system, or Install into project to use preset configs and run commands any time.

info

If you wish, you can install Nova globally (into the system) and locally (into the project) at the same time. They will not conflict with each other.

First Successful Check

After a project install, use this short path to create Nova's project metadata and prove the TypeScript and ESLint presets work together.

  1. Start the guided config wizard from the project root.

    bash
    npx nova utility initialize

  2. Keep the generated nova.config.json small at first. Project identity and the detected workspace entries are enough; the complete config reference is available when you need recipes, workflows, or environment delivery.

  3. Add one repeatable check script to package.json.

    package.json
    json
    {
  "scripts": {
    "check": "eslint . --max-warnings=0 && nova utility type-check"
  }
}

  4. Run the same check locally that continuous integration can run later. Use the client named by the root packageManager field.

When that command passes, the minimal setup is complete. Add stricter presets and Nova generators one at a time so a failing check points to one understandable change.

Next Steps

  • See CLI for generators and project scaffolding.
  • See Presets to choose ESLint and TSConfig scenarios.
  • See Toolkit for batteries-included dev tools.