You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It recursively unblocks ShareSurfer PowerShell files, imports the module, and opens the **ShareSurfer Start Menu**. In a normal PowerShell ConsoleHost it uses arrow-key selection; redirected or locked-down consoles automatically fall back to numbered prompts, and you can force that behavior with `-ConsoleMode Plain`. From the menu you can review readiness, build ownership inputs, start the guided scan setup, validate exports, package the standalone dashboard, and review stop gates. The scan setup asks the first-run questions, asks whether to run intensive share-permission diagnostics before the scan, checks the `inputs` folder for ownership files, offers one ownership-input decision screen, saves `sharesurfer-startup.config.json`, and writes `operator-assistant.plan.json` plus `operator-assistant-rerun.ps1`. In the interactive path it then shows a final review screen, offers to show the generated files, and asks whether to run the generated diagnostic/scan/validate/dashboard script now. The run prompt defaults to No.
53
+
It recursively unblocks ShareSurfer PowerShell files, imports the module, and opens the **ShareSurfer Start Menu**. The default menu uses reliable numbered prompts for Windows PowerShell 5.1; operators who want arrow-key selection can opt in with `-ConsoleMode Enhanced`, and redirected or locked-down consoles can still use `-ConsoleMode Plain`. From the menu you can review readiness, build ownership inputs, start the guided scan setup, validate exports, package the standalone dashboard, and review stop gates. The scan setup asks the first-run questions, asks whether to run intensive share-permission diagnostics before the scan, checks the `inputs` folder for ownership files, offers one ownership-input decision screen, saves `sharesurfer-startup.config.json`, and writes `operator-assistant.plan.json` plus `operator-assistant-rerun.ps1`. In the interactive path it then shows a final review screen, offers to show the generated files, and asks whether to run the generated diagnostic/scan/validate/dashboard script now. The run prompt defaults to No.
54
54
55
55
5. Choose the scan route: UNC path, `-ComputerName` and `-ShareName`, or `-SmbCollectionProvider NativeSmbRpc` when WinRM/CIM is blocked. The startup diagnostic path automatically checks whether a server-returned local path such as `C:\Public\Share` really exists on the collector; when it does not, ShareSurfer attempts the target UNC path instead and records that decision in `share-permission-diagnostics\share_permission_diagnostics.md` and `.csv`.
56
56
6. Pick `-ObsAttribute`. The default is `extensionAttribute10`; some labs or smaller AD schemas may need another attribute such as `info`.
57
57
7. Run the generated rerun script or `Invoke-ShareSurferScan`, then always run `Test-ShareSurferExport`.
58
58
8. Open `report.html`, or package a real export with `scripts\New-ShareSurferStandaloneDashboard.ps1`.
59
59
9. Review the stop gates before owner signoff or migration planning.
60
60
61
-
New operators should start with the [first-run guide](docs/first-run-guide.md) and keep the [command recipes](docs/command-recipes.md) nearby. For a guided console starting point, run `Start-ShareSurfer.ps1` from the release root; it opens the ShareSurfer Start Menu unless you supply `-ConfigPath` for startup replay. After importing the module, advanced operators can run `Start-ShareSurfer` for the same menu or `Start-ShareSurferStartup` to jump directly into startup config generation. The startup flow writes a reusable JSON config and delegates to `Start-ShareSurferOperatorAssistant`; it does not collect data or change permissions until you review and run the generated rerun script. If the arrow-key menu feels rough in an older host, rerun with `-ConsoleMode Plain`. If `owner-mapping.csv` or `ownership-enrichment.csv` is missing, interactive startup first offers to use discovered files and skip missing ones, offers to build missing `ownership-enrichment.csv` from candidate CSVs, or lets you enter advanced custom paths. It can also queue a post-scan `owner-mapping-draft.csv` for the first rerun.
61
+
New operators should start with the [first-run guide](docs/first-run-guide.md) and keep the [command recipes](docs/command-recipes.md) nearby. For a guided console starting point, run `Start-ShareSurfer.ps1` from the release root; it opens the ShareSurfer Start Menu unless you supply `-ConfigPath` for startup replay. After importing the module, advanced operators can run `Start-ShareSurfer` for the same menu or `Start-ShareSurferStartup` to jump directly into startup config generation. The startup flow writes a reusable JSON config and delegates to `Start-ShareSurferOperatorAssistant`; it does not collect data or change permissions until you review and run the generated rerun script. The default menu uses numbered prompts; use `-ConsoleMode Enhanced` only when you specifically want arrow-key selection in a console that handles it well. If `owner-mapping.csv` or `ownership-enrichment.csv` is missing, interactive startup first offers to use discovered files and skip missing ones, offers to build missing `ownership-enrichment.csv` from candidate CSVs, or lets you enter advanced custom paths. It can also queue a post-scan `owner-mapping-draft.csv` for the first rerun.
The menu shows readiness for ownership inputs, saved startup config, export validation, standalone dashboard packaging, and stop gates. Each menu entry previews the command it will run before asking for confirmation. A normal ConsoleHost uses arrow-key selection; add `-ConsoleMode Plain`when you want simple numbered prompts. If you want to replay an existing startup config without the menu, pass `-ConfigPath` to the same launcher.
96
+
The menu shows readiness for ownership inputs, saved startup config, export validation, standalone dashboard packaging, and stop gates. Each menu entry previews the command it will run before asking for confirmation. The default menu uses simple numbered prompts for Windows PowerShell 5.1; add `-ConsoleMode Enhanced` only when you specifically want arrow-key selection in a console that handles it well. If you want to replay an existing startup config without the menu, pass `-ConfigPath` to the same launcher.
97
97
98
98
If you already know the answers and want to generate the same files without prompts, import the module and call the startup command directly:
Copy file name to clipboardExpand all lines: docs/first-run-guide.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ Confirm the commands are available:
136
136
Get-Command -Module ShareSurfer
137
137
```
138
138
139
-
Recommended: generate a guided startup plan before scanning. This does not collect data or change permissions. It recursively unblocks local ShareSurfer PowerShell files, asks the first-run questions when run interactively, asks whether to run intensive share-permission diagnostics before the scan, checks for optional ownership files in the input folder, writes a reusable startup JSON config, then writes a JSON plan and a rerun script so you can review the requested diagnostic, scan, validation, and standalone dashboard packaging steps first. Optional CSV paths are only used by the rerun script when those files exist. The menu uses arrow-key prompts in a normal ConsoleHost and falls back to numbered prompts when the console does not support raw keys; use `-ConsoleMode Plain` if an older PowerShell 5.1 host feels clunky.
139
+
Recommended: generate a guided startup plan before scanning. This does not collect data or change permissions. It recursively unblocks local ShareSurfer PowerShell files, asks the first-run questions when run interactively, asks whether to run intensive share-permission diagnostics before the scan, checks for optional ownership files in the input folder, writes a reusable startup JSON config, then writes a JSON plan and a rerun script so you can review the requested diagnostic, scan, validation, and standalone dashboard packaging steps first. Optional CSV paths are only used by the rerun script when those files exist. The menu defaults to reliable numbered prompts for Windows PowerShell 5.1; use `-ConsoleMode Enhanced` only when you specifically want arrow-key selection in a console that handles it well.
140
140
141
141
When startup reaches ownership inputs, choose **Use discovered files and skip missing files** for the safest first run. If `ownership-enrichment.csv` is missing, choose **Build ownership enrichment now** to open the multi-CSV ownership import picker when you have HR, employee, OBS, project, application, or owner CSVs that should enrich identities before the scan. Choose **Enter advanced custom paths** only when your CSVs are outside the `inputs` folder. The ownership import writes `ownership-enrichment.csv`, `ownership_context.csv`, `ownership_relationships.csv`, `ownership_import_manifest.csv`, `ownership-import.definition.json`, and `ownership-import-rerun.ps1`, then returns to the normal startup flow.
"releaseNotesSummary": "Unsigned pre-1.0 startup ACL export mode fix release. v0.1.0-pre.43 includes the v0.1.0-pre.42 export-classification performance work plus a startup/menu fix so guided runs preserve AclExportMode instead of silently falling back to FullEffective. The release-root launcher, Start Menu preview, startup JSON config, operator assistant plan, and generated rerun script now carry Compact or FullEffective consistently into Invoke-ShareSurferScan. Guided startup defaults to Compact for large operator reviews; direct Invoke-ShareSurferScan still uses its own parameter behavior and can be run with -AclExportMode Compact when desired. The package includes the built PowerShell module files, startup launcher, diagnostic scripts, documentation, hashes, release manifest, dependency-age report, and prebuilt standalone dashboard template assets.",
8
+
"releaseNotesSummary": "Unsigned pre-1.0 startup ACL export mode fix release. v0.1.0-pre.43 includes the v0.1.0-pre.42 export-classification performance work plus a startup/menu fix so guided runs preserve AclExportMode instead of silently falling back to FullEffective. The release-root launcher, Start Menu preview, startup JSON config, operator assistant plan, and generated rerun script now carry Compact or FullEffective consistently into Invoke-ShareSurferScan. Guided startup defaults to Compact for large operator reviews; direct Invoke-ShareSurferScan still uses its own parameter behavior and can be run with -AclExportMode Compact when desired. This release also accepts AclExportMode as a compatibility no-op for older ownership-import rerun scripts and defaults the Start Menu to reliable numbered prompts while keeping enhanced arrow-key prompts available with -ConsoleMode Enhanced. The package includes the built PowerShell module files, startup launcher, diagnostic scripts, documentation, hashes, release manifest, dependency-age report, and prebuilt standalone dashboard template assets.",
@@ -524,7 +591,12 @@ function Invoke-ShareSurferConsoleTextCommand {
524
591
[string]$State.HelpText
525
592
}
526
593
else {
527
-
'Type a value and press Enter, or press Enter alone to accept the default. S skips when available. B goes back when available. Q cancels when available.'
0 commit comments