resources/cli/NovaCliHelp.txt
|
usage: nova [--version|-v] [--help|-h] <command> [<args>] These are common Nova commands used in various situations: start a new module project init Create a new Nova module scaffold work with the current project info Show project information version Show the current project version, or use --installed/-i for the locally installed project module version build Build the module into the dist folder test Run Pester tests for the project package Build, test, and package the module as configured package artifact(s) deploy Upload generated package artifact(s) to a raw HTTP endpoint bump Update the module version in project.json update Update the installed NovaModuleTools module using the stored prerelease preference notification Show or change prerelease self-update eligibility publish and release publish Build, test, and publish the module locally or to a repository release Run the full release flow (build, test, version bump, rebuild, publish) global options --help, -h Show this help message --version, -v Show the installed NovaModuleTools module name and version, including prerelease label when present routed command options --verbose, -v Show verbose output for build, test, package, deploy, bump, update, notification, publish, and release --what-if, -w Preview build, test, deploy, bump, update, notification, publish, and release without changing files --confirm, -c Request confirmation before mutating routed commands; nova bump keeps its CLI-friendly confirmation prompt Examples: nova init nova init --help nova -h init nova init --path ~/Work nova init -p ~/Work nova init --example nova init -e --path ~/Work nova info nova version nova version --installed nova version -i nova build nova build --verbose nova build -v nova build --what-if nova build -w nova build --confirm nova build -c nova test nova package nova deploy --repository LocalNexus nova deploy -r LocalNexus nova deploy --url https://packages.example/raw/ --token $env:NOVA_PACKAGE_TOKEN nova publish --local nova publish --repository PSGallery --api-key <key> nova bump --preview --what-if nova update nova notification nova notification --disable nova notification -d nova notification --enable nova notification -e nova bump nova release --repository PSGallery --api-key <key> After installing the module on macOS/Linux, run Install-NovaCli once if you want the standalone 'nova' command available from zsh/bash. Use 'nova <command>' to run a command, or call the underlying PowerShell cmdlet directly when you want a scriptable function interface. Use 'nova <command> --help' or 'nova <command> -h' for short command help. Use 'nova --help <command>' or 'nova -h <command>' for long command help. CLI help is launcher-native and uses CLI syntax only. Use PowerShell 'Get-Help' when you want PowerShell cmdlet help instead. Use 'nova notification' to show the current prerelease self-update preference, 'nova notification --disable' or 'nova notification -d' to keep 'nova update' on stable releases only, and 'nova notification --enable' or 'nova notification -e' to allow prerelease self-update targets again. Use 'nova version' for the current project version from project.json, 'nova version --installed' or 'nova version -i' for the locally installed version of the current project/module, and 'nova --version' for the installed NovaModuleTools version. Root '-v' means '--version', while command-level '-v' means '--verbose' for supported routed commands such as 'nova build -v' and 'nova publish -v'. Use 'nova update' to self-update NovaModuleTools. It uses the stored prerelease preference to decide whether a prerelease target is eligible. Stable updates proceed normally, while prerelease targets require explicit confirmation before the update runs. Use 'nova deploy' when you want to push existing package artifacts from the configured package output directory to a raw repository endpoint. Inside PowerShell, 'nova publish --local' also reloads the published module from the local install path after a successful publish. For more information, documentation, and examples, visit: https://www.novamoduletools.com/ Note: 'nova init' is interactive. Use 'nova init --path <path>' or 'nova init -p <path>' for an explicit destination, 'nova init --example' or 'nova init -e' for the packaged example scaffold, and do not use 'nova init --what-if' or 'nova init -w'. |