Skip to content

Commit 707c989

Browse files
authored
feat(#112): clean up PowerShell help content (#120)
- Remove CLI syntax and GNU-style options from `Get-Help` pages - Update examples to use PowerShell cmdlet syntax instead of CLI commands
1 parent 79ad899 commit 707c989

16 files changed

Lines changed: 112 additions & 125 deletions

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
118118
easier to scan and less visually cramped.
119119
- The getting started and core workflows guides now let readers switch between PowerShell and command-line
120120
examples, including the local-publish-plus-`pwsh` handoff for `Get-ExampleGreeting` and fresh-process `pwsh`
121+
122+
- Clean the generated PowerShell cmdlet help so `Get-Help` pages no longer mix in `nova` launcher syntax or GNU-style
123+
CLI options.
121124
import/reload validation from the command-line path.
122125
- The command reference, working-with-modules, packaging-and-delivery, versioning-and-updates, and troubleshooting
123126
guides now use the same centered command-surface header and PowerShell/command-line example switching model.

docs/NovaModuleTools/en-US/Deploy-NovaPackage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ raw repository named `LocalNexus` from `Package.Repositories`.
6363
### EXAMPLE 2
6464

6565
```powershell
66-
% nova deploy --repository LocalNexus
66+
PS> Deploy-NovaPackage -Repository LocalNexus -WhatIf
6767
```
6868

69-
Runs the same raw package upload flow through the Nova CLI.
69+
Previews the raw package upload flow and the resolved destination URLs without uploading artifacts.
7070

7171
### EXAMPLE 3
7272

docs/NovaModuleTools/en-US/Get-NovaUpdateNotificationPreference.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,13 @@ PS> Get-NovaUpdateNotificationPreference [<CommonParameters>]
2626
## DESCRIPTION
2727

2828
`Get-NovaUpdateNotificationPreference` returns the current user preference that controls whether
29-
`Update-NovaModuleTool` / `Update-NovaModuleTools` and `% nova update` may select prerelease versions of
30-
`NovaModuleTools`.
29+
`Update-NovaModuleTool` / `Update-NovaModuleTools` may select prerelease versions of `NovaModuleTools`.
3130

32-
The same stored preference is also used by `Update-NovaModuleTool` (alias: `Update-NovaModuleTools`) and `% nova update`
33-
when they decide whether a prerelease self-update is eligible.
31+
The same stored preference is also used by `Update-NovaModuleTool` (alias: `Update-NovaModuleTools`) when it decides
32+
whether a prerelease self-update is eligible.
3433

3534
Stable self-updates remain available and do not require prerelease eligibility.
3635

37-
If you prefer the Nova CLI surface, run `% nova notification` to view the same preference.
38-
3936
## EXAMPLES
4037

4138
### EXAMPLE 1
@@ -50,10 +47,11 @@ preference is stored.
5047
### EXAMPLE 2
5148

5249
```text
53-
% nova notification
50+
PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications
51+
PS> Get-NovaUpdateNotificationPreference
5452
```
5553

56-
Shows the same prerelease self-update state from the Nova CLI entrypoint.
54+
Shows the stored preference after prerelease self-updates have been disabled.
5755

5856
## PARAMETERS
5957

@@ -77,15 +75,13 @@ Returns the prerelease self-update state, the always-available stable-update sta
7775

7876
## NOTES
7977

80-
Use `PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications` or `$ nova notification --disable` /
81-
`$ nova notification -d` to stop prerelease self-updates from being eligible.
78+
Use `Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications` to stop prerelease self-updates from being
79+
eligible.
8280

83-
Use `PS> Set-NovaUpdateNotificationPreference -EnablePrereleaseNotifications` or `$ nova notification --enable` /
84-
`$ nova notification -e` to allow prerelease self-updates again.
81+
Use `Set-NovaUpdateNotificationPreference -EnablePrereleaseNotifications` to allow prerelease self-updates again.
8582

86-
When prerelease notifications are enabled again, `Update-NovaModuleTool` / `Update-NovaModuleTools` and `% nova update`
87-
may again select a prerelease target. Prerelease self-updates still require explicit confirmation before the update
88-
proceeds.
83+
When prerelease notifications are enabled again, `Update-NovaModuleTool` / `Update-NovaModuleTools` may again select a
84+
prerelease target. Prerelease self-updates still require explicit confirmation before the update proceeds.
8985

9086
## RELATED LINKS
9187

docs/NovaModuleTools/en-US/Initialize-NovaModule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ prompt flow to the copied `project.json`.
7474
### EXAMPLE 4
7575

7676
```text
77-
% nova init --example --path ~/Work
77+
PS> Initialize-NovaModule -Example -Path ~/Work -WhatIf
7878
```
7979

80-
Runs the same example-based scaffold flow through the `nova` CLI.
80+
Shows what the example-based scaffold flow would create without writing files.
8181

8282
## PARAMETERS
8383

docs/NovaModuleTools/en-US/Invoke-NovaBuild.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ The command:
4040
6. copies project resources into the built module output
4141

4242
To update the installed `NovaModuleTools` module itself, use `Update-NovaModuleTool` (alias:
43-
`Update-NovaModuleTools`) or `% nova update`.
43+
`Update-NovaModuleTools`).
4444

45-
Use `Set-NovaUpdateNotificationPreference`, `Get-NovaUpdateNotificationPreference`, or the `% nova notification`
46-
commands when you want to control whether prerelease self-updates are eligible.
45+
Use `Set-NovaUpdateNotificationPreference` or `Get-NovaUpdateNotificationPreference` when you want to control whether
46+
prerelease self-updates are eligible.
4747

4848
If `Invoke-NovaBuild` detects that a newer `NovaModuleTools` release or prerelease is available after the build, the
4949
warning includes the recommended update command together with the release notes link from the installed module

docs/NovaModuleTools/en-US/Invoke-NovaCli.md

Lines changed: 19 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,17 @@ PS> Invoke-NovaCli [[-Command] <string>] [[-Arguments] <string[]>] [-WhatIf] [-C
2929

3030
Use it when you need scripted routing inside PowerShell, for example in tests, automation, or wrapper functions.
3131

32-
Use the installed `nova` launcher when you want the end-user CLI experience. The module does not export `nova` as a
33-
PowerShell alias.
32+
`Invoke-NovaCli` routes the same top-level command names as the bundled command-line launcher, but it keeps the entry
33+
surface explicit for PowerShell callers.
3434

35-
`Invoke-NovaCli` routes the same top-level commands that the launcher supports, including `% nova info`, `% nova
36-
version`, `% nova --version`, `% nova --help`, `% nova build`, `% nova test`, `% nova package`, `% nova deploy`, `% nova
37-
init`, `% nova bump`, `% nova update`, `% nova notification`, `% nova publish`, and `% nova release`.
35+
Use `-Command` to select the routed command and `-Arguments` when a routed command needs additional raw arguments.
3836

39-
Mutating routed commands forward CLI `--verbose`/`-v` and `--what-if`/`-w` to the underlying cmdlet. Routed CLI
40-
`--confirm`/`-c` is handled by the shared CLI confirmation flow so the launcher never exposes PowerShell's interactive
41-
`Suspend` prompt.
42-
43-
Only the supported mutating `nova` commands accept `--confirm`/`-c`. Read-only routes and `% nova init` reject the CLI
44-
confirm flag with a clear validation error.
37+
When `-Command` is omitted, `Invoke-NovaCli` routes to the root help view.
4538

4639
Direct PowerShell cmdlets such as `Invoke-NovaBuild`, `Publish-NovaModule`, `Deploy-NovaPackage`,
4740
`Update-NovaModuleVersion`, and `Invoke-NovaRelease` keep their native `-WhatIf` and `-Confirm` behavior when called
4841
directly.
4942

50-
Use `% nova <command> --help` or `% nova <command> -h` when you want short CLI help for a specific command.
51-
52-
Use `% nova --help <command>` or `% nova -h <command>` when you want long CLI help for a specific command.
53-
54-
The launcher help is CLI-native and uses CLI option spellings such as `--repository` and `-r`. Use PowerShell
55-
`Get-Help` when you want cmdlet help instead.
56-
5743
## EXAMPLES
5844

5945
### EXAMPLE 1
@@ -67,68 +53,44 @@ Routes the build workflow through the explicit PowerShell cmdlet entrypoint.
6753
### EXAMPLE 2
6854

6955
```text
70-
PS> Invoke-NovaCli -Command publish -Arguments @('--local') -WhatIf
56+
PS> Invoke-NovaCli -Command version
7157
```
7258

73-
Routes the local publish workflow while keeping native PowerShell `-WhatIf` on the outer call.
59+
Routes the version workflow through the explicit PowerShell cmdlet entrypoint.
7460

7561
### EXAMPLE 3
7662

7763
```text
78-
PS> Invoke-NovaCli -Command init -Arguments @('--example', '--path', '~/Work')
64+
PS> Invoke-NovaCli -Command update -WhatIf
7965
```
8066

81-
Starts the example scaffold flow from the explicit PowerShell cmdlet entrypoint.
67+
Routes the self-update workflow while previewing the outer PowerShell action.
8268

8369
### EXAMPLE 4
8470

8571
```text
86-
% nova build --confirm
72+
PS> Invoke-NovaCli -Command notification
8773
```
8874

89-
Runs the routed build workflow through the launcher-facing CLI surface and uses the shared CLI confirmation flow.
75+
Routes the notification-preference status workflow through the explicit PowerShell cmdlet entrypoint.
9076

9177
### EXAMPLE 5
9278

9379
```text
94-
% nova version --installed
95-
```
96-
97-
Returns the locally installed version of the current project/module.
98-
99-
### EXAMPLE 6
100-
101-
```text
102-
% nova --version
103-
```
104-
105-
Returns the installed `NovaModuleTools` module version.
106-
107-
### EXAMPLE 7
108-
109-
```text
110-
% nova update
111-
```
112-
113-
Runs the self-update flow through the launcher-oriented CLI surface.
114-
115-
### EXAMPLE 8
116-
117-
```text
118-
% nova notification --disable
80+
PS> Invoke-NovaCli -Command build -Confirm
11981
```
12082

121-
Disables prerelease self-update eligibility through the launcher-facing CLI surface.
83+
Prompts before the routed build workflow starts.
12284

12385
## PARAMETERS
12486

12587
### -Command
12688

127-
Top-level Nova command to route. Defaults to `--help`.
89+
Top-level Nova command to route. When omitted, the cmdlet routes to the root help view.
12890

12991
```yaml
13092
Type: System.String
131-
DefaultValue: --help
93+
DefaultValue: (root help view)
13294
SupportsWildcards: false
13395
Aliases: [ ]
13496
ParameterSets:
@@ -147,6 +109,8 @@ HelpMessage: ''
147109
148110
Raw routed argument list for the selected Nova command.
149111
112+
Use this parameter when a routed command needs additional command-specific arguments.
113+
150114
```yaml
151115
Type: System.String[]
152116
DefaultValue: ''
@@ -187,10 +151,11 @@ Returns the same output that the selected routed Nova command returns.
187151
Use `Invoke-NovaCli` directly when you need the underlying PowerShell command in scripts, tests, or command dispatch
188152
scenarios.
189153

190-
Install the bundled `nova` launcher with `Install-NovaCli` when you want `% nova ...` available from your shell.
154+
Install the bundled command-line launcher with `Install-NovaCli` when you want the same routed command surface from
155+
your shell.
191156

192157
`Invoke-NovaCli` uses `SupportsShouldProcess` so the outer PowerShell call still surfaces native `-WhatIf` and
193-
`-Confirm`, while routed CLI `--confirm`/`-c` stays inside the shared CLI confirmation flow.
158+
`-Confirm` support.
194159

195160
## RELATED LINKS
196161

docs/NovaModuleTools/en-US/New-NovaModulePackage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ when `Package.Types` is omitted or resolves to `NuGet`.
8787
### EXAMPLE 2
8888

8989
```text
90-
% nova package
90+
PS> New-NovaModulePackage -WhatIf
9191
```
9292

93-
Runs the same packaging workflow through the `nova` CLI.
93+
Previews the build, test, and packaging workflow without writing a package artifact.
9494

9595
### EXAMPLE 3
9696

docs/NovaModuleTools/en-US/NovaModuleTools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Shows whether prerelease update notifications are enabled. Stable release notifi
3232

3333
### `PS> Install-NovaCli`
3434

35-
Installs the bundled `nova` launcher into a user command directory on macOS or Linux.
35+
Installs the bundled command-line launcher into a user command directory on macOS or Linux.
3636

3737
### `PS> Invoke-NovaBuild`
3838

@@ -73,7 +73,7 @@ Builds, tests, and publishes the current project either locally or to a reposito
7373

7474
### `PS> Set-NovaUpdateNotificationPreference`
7575

76-
Enables or disables whether prerelease self-updates are eligible for `Update-NovaModuleTool` and `% nova update`.
76+
Enables or disables whether prerelease self-updates are eligible for `Update-NovaModuleTool`.
7777

7878
### `PS> Update-NovaModuleVersion`
7979

docs/NovaModuleTools/en-US/Publish-NovaModule.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,7 @@ Use repository mode when you want to publish the built module to a registered Po
4343
This command supports `-WhatIf` and `-Confirm` through PowerShell `SupportsShouldProcess`. Use `-WhatIf` to preview the
4444
resolved publish target and workflow without building, testing, or publishing.
4545

46-
When you run the same workflow through `% nova publish --confirm` / `% nova publish -c`, the CLI handles confirmation
47-
before
48-
the routed publish starts. `Y` / `Yes` and `A` / `Yes to All` continue, `N` / `No` and `L` / `No to All` cancel the
49-
publish with a non-zero exit code, and `S` / `Suspend` is treated as cancel because nested PowerShell prompts are not
50-
supported in CLI mode.
46+
Use `-Confirm` when you want PowerShell to prompt before the publish workflow starts.
5147

5248
## EXAMPLES
5349

@@ -80,10 +76,10 @@ Builds, tests, and publishes the module to `PSGallery`.
8076
### EXAMPLE 4
8177

8278
```text
83-
% nova publish --repository PSGallery --api-key $PSGALLERY_API
79+
PS> Publish-NovaModule -Repository PSGallery -Confirm
8480
```
8581

86-
Runs the same publish flow through the `nova` CLI.
82+
Prompts before the repository publish workflow starts.
8783

8884
### EXAMPLE 5
8985

@@ -215,8 +211,6 @@ source project or from `dist/`.
215211
`Publish-NovaModule` uses `SupportsShouldProcess`, so `Get-Help Publish-NovaModule -Full` should surface native
216212
`-WhatIf` and `-Confirm` support.
217213

218-
The CLI-specific `% nova publish --confirm` / `% nova publish -c` prompt is separate from native PowerShell `-Confirm`.
219-
It never opens a nested PowerShell `Suspend` prompt.
220214

221215
## RELATED LINKS
222216

docs/NovaModuleTools/en-US/Set-NovaUpdateNotificationPreference.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,13 @@ PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications [-WhatI
3232
## DESCRIPTION
3333

3434
`Set-NovaUpdateNotificationPreference` manages the user preference that controls whether
35-
`Update-NovaModuleTool` / `Update-NovaModuleTools` and `% nova update` may select prerelease versions of
36-
`NovaModuleTools`.
35+
`Update-NovaModuleTool` / `Update-NovaModuleTools` may select prerelease versions of `NovaModuleTools`.
3736

38-
The same stored preference is also used by `Update-NovaModuleTool` (alias: `Update-NovaModuleTools`) and `% nova update`
39-
when they decide whether a prerelease self-update can be selected.
37+
The same stored preference is also used by `Update-NovaModuleTool` (alias: `Update-NovaModuleTools`) when it decides
38+
whether a prerelease self-update can be selected.
4039

4140
Stable self-updates remain available and do not require prerelease eligibility.
4241

43-
If you prefer the Nova CLI surface, use `% nova notification --disable` / `% nova notification -d` and
44-
`% nova notification --enable` / `% nova notification -e` for the same stored preference.
45-
4642
## EXAMPLES
4743

4844
### EXAMPLE 1
@@ -51,8 +47,7 @@ If you prefer the Nova CLI surface, use `% nova notification --disable` / `% nov
5147
PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications
5248
```
5349

54-
Turns off prerelease self-update eligibility and restricts `Update-NovaModuleTool` / `% nova update` to stable releases
55-
only.
50+
Turns off prerelease self-update eligibility and restricts `Update-NovaModuleTool` to stable releases only.
5651

5752
### EXAMPLE 2
5853

@@ -61,23 +56,23 @@ PS> Set-NovaUpdateNotificationPreference -EnablePrereleaseNotifications
6156
```
6257

6358
Turns prerelease self-update eligibility back on, which allows `Update-NovaModuleTool` /
64-
`Update-NovaModuleTools` and `% nova update` to consider a prerelease target again.
59+
`Update-NovaModuleTools` to consider a prerelease target again.
6560

6661
### EXAMPLE 3
6762

6863
```text
69-
% nova notification --disable
64+
PS> Set-NovaUpdateNotificationPreference -DisablePrereleaseNotifications -WhatIf
7065
```
7166

72-
Uses the Nova CLI entrypoint to disable prerelease self-update eligibility.
67+
Previews the change that would disable prerelease self-update eligibility.
7368

7469
### EXAMPLE 4
7570

7671
```text
77-
% nova notification --enable
72+
PS> Set-NovaUpdateNotificationPreference -EnablePrereleaseNotifications -Confirm
7873
```
7974

80-
Uses the Nova CLI entrypoint to re-enable prerelease self-update eligibility.
75+
Prompts before the preference is changed to allow prerelease self-updates again.
8176

8277
## PARAMETERS
8378

@@ -201,7 +196,6 @@ Returns the current prerelease self-update state, the always-available stable-up
201196

202197
Use this command together with `Get-NovaUpdateNotificationPreference` when you want to confirm the stored setting.
203198

204-
Use `% nova notification` when you want to view the same setting through the CLI surface.
205199

206200
## RELATED LINKS
207201

0 commit comments

Comments
 (0)