-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommands.html
More file actions
728 lines (701 loc) · 45 KB
/
Copy pathcommands.html
File metadata and controls
728 lines (701 loc) · 45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="width=device-width, initial-scale=1" name="viewport">
<title>NovaModuleTools — Command cheat sheet</title>
<meta content="Toggle this cheat sheet between the nova launcher and PowerShell cmdlets so setup, build, test, package, publish, release, versioning, and self-update examples stay on one surface."
name="description">
<meta content="index,follow,max-image-preview:large" name="robots">
<meta content="#0b1020" name="theme-color">
<link href="https://www.novamoduletools.com/commands.html" rel="canonical">
<link href="./assets/icon.png" rel="icon" type="image/png">
<link href="./assets/icon.png" rel="apple-touch-icon">
<meta content="article" property="og:type">
<meta content="NovaModuleTools — Command cheat sheet" property="og:title">
<meta content="Switch between nova and PowerShell so the command reference matches the workflow surface you actually want to use."
property="og:description">
<meta content="https://www.novamoduletools.com/commands.html" property="og:url">
<meta content="https://www.novamoduletools.com/assets/icon.png" property="og:image">
<meta content="summary" name="twitter:card">
<meta content="NovaModuleTools — Command cheat sheet" name="twitter:title">
<meta content="Switch between nova and PowerShell so the command reference matches the workflow surface you actually want to use."
name="twitter:description">
<link href="./assets/site.css" rel="stylesheet">
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "NovaModuleTools command cheat sheet",
"description": "Toggleable command cheat sheet for the nova launcher and NovaModuleTools PowerShell cmdlets.",
"url": "https://www.novamoduletools.com/commands.html"
}
</script>
</head>
<body class="guide-page">
<header class="site-header">
<div class="site-header__inner">
<a class="site-brand" href="./index.html">
<img alt="" class="site-brand__icon" src="./assets/icon.png">
<span class="site-brand__text">NovaModuleTools</span>
</a>
<div aria-label="Command display mode" class="site-header__command-surface">
<div aria-label="Command display mode" class="surface-tabs" role="tablist">
<button aria-selected="true" class="surface-tabs__button" data-command-mode="powershell" role="tab"
type="button">PowerShell
</button>
<button aria-selected="false" class="surface-tabs__button" data-command-mode="command-line" role="tab"
type="button">Command-line
</button>
</div>
</div>
<div class="site-header__actions">
<details class="site-menu">
<summary class="site-menu__button">
<span class="site-menu__button-label">Menu</span>
<span class="site-menu__current">Command Cheat Sheet</span>
</summary>
<nav aria-label="Primary" class="site-menu__panel">
<a class="site-nav__link" href="./index.html">Home</a>
<a class="site-nav__link" href="./getting-started.html">Getting Started</a>
<a class="site-nav__link" href="./core-workflows.html">Core Workflows</a>
<a class="site-nav__link" href="./working-with-modules.html">Working with Modules</a>
<a class="site-nav__link" href="./project-json-reference.html">project.json Reference</a>
<a aria-current="page" class="site-nav__link site-nav__link--active" href="./commands.html">Command
Cheat Sheet</a>
<a class="site-nav__link" href="./packaging-and-delivery.html">Packaging & Delivery</a>
<a class="site-nav__link" href="./versioning-and-updates.html">Versioning & Updates</a>
<a class="site-nav__link" href="./troubleshooting.html">Troubleshooting</a>
<a class="site-nav__link" href="./advanced.html">Concepts</a>
<a class="site-nav__link" href="./release-notes.html">Release Notes</a>
</nav>
</details>
</div>
</div>
</header>
<main class="page-shell">
<section class="guide-hero">
<p class="eyebrow">Reference</p>
<h1>Keep one workflow surface in view</h1>
<p class="lead">This page is a cheat sheet, not cmdlet help. Pick <span data-command-surface-label>PowerShell</span>
once, then read examples and notes that stay on that surface.</p>
<p class="tiny-note">Use the toggle to switch between the native <code>pwsh</code> cmdlet experience and the
standalone <code>nova</code> launcher workflow.</p>
</section>
<section class="content-grid">
<aside class="toc-card">
<h2>On this page</h2>
<ul class="toc-list">
<li><a href="#choose-surface">Choose your surface</a></li>
<li><a href="#setup-and-project">Set up a project</a></li>
<li><a href="#build-and-validate">Build and validate</a></li>
<li><a href="#package-and-ship">Package and ship</a></li>
<li><a href="#version-and-update">Version and update</a></li>
</ul>
</aside>
<div class="guide-content">
<section class="content-section" id="choose-surface">
<h2>Choose your surface</h2>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Command-line mode:</strong> treat <code>nova</code> as the normal launcher entrypoint for
everyday terminal work. It is the platform-native Nova experience, especially from zsh or bash on
macOS and Linux.</p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>PowerShell mode:</strong> stay on the public cmdlets when you want a native
<code>pwsh</code> workflow, PowerShell objects, and built-in <code>-WhatIf</code> /
<code>-Confirm</code> behavior.</p>
</div>
<div class="surface-note">
<p><strong>One allowed exception:</strong> installing the <code>nova</code> launcher is still a
PowerShell step because there is no CLI alternative for installing the CLI itself. Use
<code>Install-NovaCli</code> once, then stay on <code>nova</code>.</p>
</div>
<div class="table-scroll">
<table>
<thead>
<tr>
<th>Need</th>
<th>Stay on this surface</th>
</tr>
</thead>
<tbody>
<tr data-command-visibility="command-line" hidden>
<td>Daily terminal workflow</td>
<td><code>nova init → build → test → package → deploy → publish → release</code></td>
</tr>
<tr data-command-visibility="command-line" hidden>
<td>Check versions or self-update from any shell</td>
<td><code>nova version</code>, <code>nova --version</code>, <code>nova update</code></td>
</tr>
<tr data-command-visibility="powershell">
<td>Reusable scripts or structured output</td>
<td><code>Initialize-NovaModule</code>, <code>Invoke-NovaBuild</code>,
<code>Test-NovaBuild</code>, <code>Publish-NovaModule</code></td>
</tr>
<tr data-command-visibility="powershell">
<td>Native PowerShell automation</td>
<td>Use the public cmdlets directly and keep the workflow inside <code>pwsh</code></td>
</tr>
</tbody>
</table>
</div>
</section>
<section class="content-section" id="setup-and-project">
<h2>Set up a project</h2>
<div class="command-card-grid command-card-grid--stacked">
<article class="command-card">
<h3>Install the <code>nova</code> launcher</h3>
<p>Use this one-time PowerShell setup when you want <code>nova</code> available directly from
your shell.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want the platform-native launcher on macOS, Linux, or any
shell session that should call <code>nova</code> directly
</li>
<li><strong>Why it stays here:</strong> there is no CLI alternative for installing the CLI
itself
</li>
</ul>
<pre><code>PS> Install-NovaCli
PS> Install-NovaCli -DestinationDirectory ~/bin -Force</code></pre>
<p><a class="text-link" href="./getting-started.html#install-module">See setup details</a>
</p>
</article>
<article class="command-card">
<h3>Start a new project</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova init</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Initialize-NovaModule</code></p>
</div>
<p>Create the minimal scaffold or the example scaffold for a new module project.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you are creating a fresh NovaModuleTools project</li>
<li><strong>Includes:</strong> a pre-question Nova release warning, best-effort
<code>.gitignore</code> creation or update when Git is enabled, and Nova's default
<code>Pester.CodeCoverage</code> block in <code>project.json</code>; the minimal
scaffold keeps coverage opt-in, while the packaged example scaffold starts with coverage
enabled against <code>src/**/*.ps1</code></li>
<li><strong>Optional:</strong> add the <strong>Agentic Copilot</strong> starter package for Nova-maintained
build, test, analyzer, help, and guidance files; if you enable it, Nova also asks for a
short project name for placeholders such as <code>Invoke-<ShortName>*</code></li>
<li data-command-visibility="command-line" hidden><strong>Remember:</strong> pass the target path
explicitly with <code>--path</code> or <code>-p</code></li>
<li data-command-visibility="powershell"><strong>Common parameters:</strong>
<code>-Path</code> and <code>-Example</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Create a scaffold</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova init --path ~/Work
% nova init --example --path ~/Work</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Initialize-NovaModule -Path ~/Work
PS> Initialize-NovaModule -Example -Path ~/Work</code></pre>
</div>
</div>
<p><a class="text-link" href="./getting-started.html">See the scaffold guide</a></p>
</article>
<article class="command-card">
<h3>Inspect the current project</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova info</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Get-NovaProjectInfo</code></p>
</div>
<p>Read resolved project metadata, defaults, and paths such as <code>dist/</code> and
<code>tests/</code>.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you need to confirm what Nova resolved from
<code>project.json</code></li>
<li data-command-visibility="powershell"><strong>Extra views:</strong>
<code>-Version</code> and <code>-Installed</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Inspect project metadata</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova info</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Get-NovaProjectInfo
PS> Get-NovaProjectInfo -Version
PS> Get-NovaProjectInfo -Installed</code></pre>
</div>
</div>
<p><a class="text-link" href="./project-json-reference.html">See project.json behavior</a></p>
</article>
</div>
</section>
<section class="content-section" id="build-and-validate">
<h2>Build and validate</h2>
<div class="command-card-grid">
<article class="command-card">
<h3>Build the current project</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova build</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Invoke-NovaBuild</code></p>
</div>
<p>Generate the built module in <code>dist/<ProjectName></code> before you test, package,
or publish.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want the real output Nova will package or publish</li>
<li data-command-visibility="command-line" hidden><strong>Common options:</strong>
<code>--what-if</code>, <code>--confirm</code>, and
<code>--continuous-integration</code></li>
<li data-command-visibility="powershell"><strong>Common parameters:</strong>
<code>-WhatIf</code>, <code>-Confirm</code>, and
<code>-ContinuousIntegration</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Build now</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova build
% nova build --what-if
% nova build --continuous-integration</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Invoke-NovaBuild
PS> Invoke-NovaBuild -WhatIf
PS> Invoke-NovaBuild -ContinuousIntegration</code></pre>
</div>
</div>
<p><a class="text-link" href="./core-workflows.html#build">See the build workflow</a></p>
</article>
<article class="command-card">
<h3>Run the test workflow</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova test</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Test-NovaBuild</code></p>
</div>
<p>Run Pester for the current project and write results to
<code>artifacts/TestResults.xml</code>.</p>
<p>If coverage is enabled in <code>project.json</code>, the same workflow also writes
<code>artifacts/coverage.xml</code> and fails when measured coverage stays below the
configured <code>CoveragePercentTarget</code>.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want the standard Nova test flow</li>
<li data-command-visibility="command-line" hidden><strong>Best launcher option:</strong>
<code>--build</code> rebuilds before testing
</li>
<li data-command-visibility="powershell"><strong>Cmdlet extras:</strong>
<code>-Build</code>, <code>-TagFilter</code>, <code>-ExcludeTagFilter</code>,
<code>-OutputVerbosity</code>, and <code>-OutputRenderMode</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Test the project</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova test
% nova test --build
% nova test --what-if</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Test-NovaBuild
PS> Test-NovaBuild -Build
PS> Test-NovaBuild -TagFilter unit,fast</code></pre>
</div>
</div>
<p><a class="text-link" href="./core-workflows.html#test">See the test workflow</a></p>
</article>
</div>
</section>
<section class="content-section" id="package-and-ship">
<h2>Package and ship</h2>
<div class="command-card-grid">
<article class="command-card">
<h3>Create package artifacts</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova package</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>New-NovaModulePackage</code></p>
</div>
<p>Build, test, and package the module, usually into <code>artifacts/packages/</code>.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want a reusable package artifact from the built module</li>
<li data-command-visibility="command-line" hidden><strong>Common option:</strong>
<code>--skip-tests</code> when tests already ran earlier in CI/CD
</li>
<li data-command-visibility="powershell"><strong>Common parameter:</strong>
<code>-SkipTests</code> when tests already ran earlier in CI/CD
</li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Package the module</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova package
% nova package --skip-tests</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> New-NovaModulePackage
PS> New-NovaModulePackage -SkipTests</code></pre>
</div>
</div>
<p><a class="text-link" href="./packaging-and-delivery.html#pack">See packaging details</a></p>
</article>
<article class="command-card">
<h3>Upload raw package artifacts</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova deploy</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Deploy-NovaPackage</code></p>
</div>
<p>Upload existing package files to a raw HTTP endpoint without rebuilding or retesting first.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you already have artifacts and just need the upload step</li>
<li><strong>Key inputs:</strong> repository settings, explicit URL values, or token settings
</li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Upload artifacts</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova deploy --repository LocalNexus
% nova deploy --url https://packages.example/raw/ --token $NOVA_PACKAGE_TOKEN</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Deploy-NovaPackage -Repository LocalNexus
PS> Deploy-NovaPackage -Url 'https://packages.example/raw/' -Token $env:NOVA_PACKAGE_TOKEN</code></pre>
</div>
</div>
<p><a class="text-link" href="./packaging-and-delivery.html#upload">See raw upload details</a>
</p>
</article>
<article class="command-card">
<h3>Publish the module</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova publish</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Publish-NovaModule</code></p>
</div>
<p>Build, test, and publish the module locally or to a registered PowerShell repository.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you are ready to publish instead of just package</li>
<li data-command-visibility="command-line" hidden><strong>Common options:</strong>
<code>--local</code>, <code>--repository</code>, <code>--api-key</code>,
<code>--skip-tests</code>, and <code>--continuous-integration</code></li>
<li data-command-visibility="powershell"><strong>Common parameters:</strong>
<code>-Local</code>, <code>-Repository</code>, <code>-ApiKey</code>,
<code>-SkipTests</code>, and <code>-ContinuousIntegration</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Publish now</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova publish --local
% nova publish --repository PSGallery --api-key $PSGALLERY_API
% nova publish --repository PSGallery --api-key $PSGALLERY_API --skip-tests</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Publish-NovaModule -Local
PS> Publish-NovaModule -Repository PSGallery -ApiKey $env:PSGALLERY_API
PS> Publish-NovaModule -Repository PSGallery -ApiKey $env:PSGALLERY_API -SkipTests</code></pre>
</div>
</div>
<p><a class="text-link" href="./packaging-and-delivery.html#publish">See publish details</a></p>
</article>
<article class="command-card">
<h3>Run the release workflow</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova release</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Invoke-NovaRelease</code></p>
</div>
<p>Run the end-to-end release flow: build, test, bump version, build again, and publish.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want one orchestrated release command instead of separate
steps
</li>
<li data-command-visibility="command-line" hidden><strong>Common options:</strong>
<code>--local</code>, <code>--repository</code>, <code>--api-key</code>,
<code>--skip-tests</code>, and <code>--continuous-integration</code></li>
<li data-command-visibility="powershell"><strong>Common parameters:</strong>
<code>-Local</code>, <code>-Repository</code>, <code>-ApiKey</code>,
<code>-SkipTests</code>, and <code>-ContinuousIntegration</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Release the module</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova release --local
% nova release --repository PSGallery --api-key $PSGALLERY_API
% nova release --repository PSGallery --api-key $PSGALLERY_API --skip-tests
% nova release --repository PSGallery --api-key $PSGALLERY_API --continuous-integration</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Invoke-NovaRelease -Local
PS> Invoke-NovaRelease -Repository PSGallery -ApiKey $env:PSGALLERY_API
PS> Invoke-NovaRelease -Repository PSGallery -ApiKey $env:PSGALLERY_API -SkipTests
PS> Invoke-NovaRelease -Repository PSGallery -ApiKey $env:PSGALLERY_API -ContinuousIntegration</code></pre>
</div>
</div>
<p><a class="text-link" href="./packaging-and-delivery.html#release">See release details</a></p>
</article>
</div>
</section>
<section class="content-section" id="version-and-update">
<h2>Version and update</h2>
<div class="command-card-grid">
<article class="command-card">
<h3>Plan or apply a version bump</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova bump</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Update-NovaModuleVersion</code></p>
</div>
<p>Use Git history to infer the next version and update <code>project.json</code>.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want Nova to plan or apply the semantic version change</li>
<li data-command-visibility="command-line" hidden><strong>Common options:</strong>
<code>--preview</code>, <code>--what-if</code>, <code>--confirm</code>, and
<code>--override-warning</code></li>
<li data-command-visibility="powershell"><strong>Common parameters:</strong>
<code>-Preview</code>, <code>-WhatIf</code>, <code>-ContinuousIntegration</code>, and
<code>-OverrideWarning</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Preview a bump</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova bump --preview --what-if
% nova bump --override-warning --what-if
% nova bump --preview --confirm</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Update-NovaModuleVersion -Preview -WhatIf
PS> Update-NovaModuleVersion -Path ./src/resources/example -OverrideWarning -WhatIf
PS> Update-NovaModuleVersion -ContinuousIntegration</code></pre>
</div>
</div>
<p><a class="text-link" href="./versioning-and-updates.html#bump">See versioning rules</a></p>
</article>
<article class="command-card">
<h3>Check the version you actually mean</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher routes:</strong> <code>nova version</code>,
<code>nova version --installed</code>, and <code>nova --version</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlet:</strong> <code>Get-NovaProjectInfo</code></p>
</div>
<p>Project version, installed project-module version, and installed NovaModuleTools version are
different views.</p>
<ul class="plain-list">
<li data-command-visibility="command-line" hidden><strong>Use:</strong> <code>nova version</code> for
<code>project.json</code>, <code>nova version --installed</code> for the installed
current project/module, and <code>nova --version</code> for NovaModuleTools itself
</li>
<li data-command-visibility="powershell"><strong>Use:</strong>
<code>Get-NovaProjectInfo -Version</code> for <code>project.json</code> and
<code>Get-NovaProjectInfo -Installed</code> for the installed NovaModuleTools tool
version
</li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Read the right version view</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova version
% nova version --installed
% nova version -i
% nova --version
% nova -v</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Get-NovaProjectInfo -Version
PS> Get-NovaProjectInfo -Installed</code></pre>
</div>
</div>
<p><a class="text-link" href="./versioning-and-updates.html#version-views">See version view
differences</a></p>
</article>
<article class="command-card">
<h3>Self-update NovaModuleTools</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova update</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlets:</strong> <code>Update-NovaModuleTool</code> and
<code>Update-NovaModuleTools</code></p>
</div>
<p>Update the installed NovaModuleTools module by using the stored prerelease preference.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want to update the tool itself rather than a project</li>
<li><strong>Behavior:</strong> stable updates are always eligible; prerelease targets still
need the stored preference and an explicit confirmation
</li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Update the tool</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova update</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Update-NovaModuleTool
PS> Update-NovaModuleTools</code></pre>
</div>
</div>
<p><a class="text-link" href="./versioning-and-updates.html#self-update">See self-update
behavior</a></p>
</article>
<article class="command-card">
<h3>Manage prerelease update preference</h3>
<div class="surface-note" data-command-visibility="command-line" hidden>
<p><strong>Launcher route:</strong> <code>nova notification</code></p>
</div>
<div class="surface-note" data-command-visibility="powershell">
<p><strong>Cmdlets:</strong> <code>Get-NovaUpdateNotificationPreference</code> and
<code>Set-NovaUpdateNotificationPreference</code></p>
</div>
<p>Inspect or change whether prerelease self-updates are eligible.</p>
<ul class="plain-list">
<li><strong>Use when:</strong> you want to stay on stable releases or opt into prerelease
updates on purpose
</li>
<li><strong>Settings file:</strong> <code>%APPDATA%</code> on Windows, otherwise
<code>$XDG_CONFIG_HOME</code> when set, then
<code>~/.config/NovaModuleTools/settings.json</code></li>
</ul>
<div class="surface-example" data-command-example>
<div class="surface-example__meta">
<p class="surface-example__title">Inspect or change prerelease eligibility</p>
<p class="surface-example__status">Showing: <span
data-command-surface-label>PowerShell</span></p>
</div>
<div class="surface-example__surface" data-command-surface="command-line" hidden>
<pre><code>% nova notification
% nova notification --disable
% nova notification --enable</code></pre>
</div>
<div class="surface-example__surface" data-command-surface="powershell">
<pre><code>PS> Get-NovaUpdateNotificationPreference
PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications
PS> Set-NovaUpdateNotificationPreference -EnablePrereleaseNotifications</code></pre>
</div>
</div>
<p><a class="text-link" href="./versioning-and-updates.html#notification-preferences">See
preference guidance</a></p>
</article>
</div>
</section>
</div>
</section>
</main>
<footer class="footer">
<div class="footer__inner">
<h2>Need the next layer of detail?</h2>
<p>Use the workflow pages when you want step-by-step guidance. Keep this page for fast command selection.</p>
<div class="hero__actions">
<a class="button button--primary" href="./core-workflows.html">Open Core Workflows</a>
<a class="button button--secondary" href="./project-json-reference.html">Open project.json Reference</a>
</div>
<p class="footer__legal">Also available: <a class="legal-link" href="./working-with-modules.html">Working with
Modules</a> and <a class="legal-link" href="./release-notes.html">Release Notes</a>.</p>
</div>
</footer>
<script>
(() => {
const storageKey = 'nova-doc-command-surface';
const supportedModes = ['powershell', 'command-line'];
function readStoredMode() {
try {
const stored = window.localStorage.getItem(storageKey);
return supportedModes.includes(stored) ? stored : 'powershell';
} catch {
return 'powershell';
}
}
function writeStoredMode(mode) {
try {
window.localStorage.setItem(storageKey, mode);
} catch {
// Ignore storage failures and keep the page interactive.
}
}
function getModeLabel(mode) {
return mode === 'powershell' ? 'PowerShell' : 'Command-line';
}
function applyMode(mode) {
document.querySelectorAll('[data-command-mode]').forEach((button) => {
const selected = button.dataset.commandMode === mode;
button.setAttribute('aria-selected', selected ? 'true' : 'false');
});
document.querySelectorAll('[data-command-example]').forEach((example) => {
example.querySelectorAll('[data-command-surface]').forEach((surface) => {
surface.hidden = surface.dataset.commandSurface !== mode;
});
});
document.querySelectorAll('[data-command-surface-label]').forEach((label) => {
label.textContent = getModeLabel(mode);
});
document.querySelectorAll('[data-command-visibility]').forEach((element) => {
element.hidden = element.dataset.commandVisibility !== mode;
});
}
document.addEventListener('DOMContentLoaded', () => {
const initialMode = readStoredMode();
applyMode(initialMode);
document.querySelectorAll('[data-command-mode]').forEach((button) => {
button.addEventListener('click', () => {
const nextMode = button.dataset.commandMode;
if (!supportedModes.includes(nextMode)) {
return;
}
applyMode(nextMode);
writeStoredMode(nextMode);
});
});
});
})();
</script>
</body>
</html>