Getting started

Install NovaModuleTools and create your first project

This guide takes you from installation to a working PowerShell module scaffold.

1. Install the module

Install NovaModuleTools from the PowerShell Gallery and load it into your session:

Install-Module -Name NovaModuleTools
Import-Module NovaModuleTools

After import, you can use the PowerShell cmdlets directly, and the nova alias is also available inside PowerShell.

2. Optional CLI launcher for macOS and Linux

If you want to run nova directly from your shell instead of from inside PowerShell, install the launcher:

Install-NovaCli

The launcher is copied to ~/.local/bin/nova by default. If that folder is not on your shell path yet, add it:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

On Windows, keep using the nova alias inside PowerShell after importing the module.

3. Create your first project

The normal entry point is the scaffold flow:

nova init

If you want to create the project under a specific parent folder, make the destination explicit:

nova init -Path ~/Work

NovaModuleTools will ask for:

  • module name
  • description
  • starting semantic version
  • author name
  • minimum PowerShell version
  • whether Git should be initialized

When the prompts finish, you get a project folder with src/, tests/ (if enabled), and project.json.

4. Start from the packaged example when you want a working reference

If you would rather inspect a complete example than start from a minimal scaffold, use:

nova init -Example
nova init -Example -Path ~/Work

This creates a project from the packaged example template, including source files, a resource file, and tests. The interactive prompt still applies your own project name, description, version, author, and PowerShell version.

5. What to do next

After your project exists, continue with the workflow guides:

Need help choosing settings later? Continue to Advanced Usage for deeper project.json options and CI guidance.