PowerShell/docs/export-to-serenade.md

66 lines
2.1 KiB
Markdown
Raw Normal View History

2021-12-09 16:19:09 +01:00
## export-to-serenade.ps1 - Exports scripts to Serenade
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script exports all scripts to Serenade to execute them by voice.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
export-to-serenade.ps1 [[-WakeWord] <String>] [[-FilePattern] <String>] [[-Application] <String>] [[-TargetFile] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-WakeWord <String>
2021-12-09 16:19:09 +01:00
Specifies the wake word (none by default)
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilePattern <String>
Specifies the file pattern for the scripts ("$PSScriptRoot/*.ps1" by default)
Required? false
Position? 2
Default value "$PSScriptRoot/*.ps1"
Accept pipeline input? false
Accept wildcard characters? false
-Application <String>
Specifies the application to be used
Required? false
Position? 3
Default value terminal
Accept pipeline input? false
Accept wildcard characters? false
-TargetFile <String>
2021-12-09 16:19:09 +01:00
Specifies the target file ("$HOME\.serenade\scripts\PowerShell.js" by default)
2021-11-08 21:36:42 +01:00
Required? false
Position? 4
2021-12-09 16:19:09 +01:00
Default value "$HOME\.serenade\scripts\PowerShell.js"
2021-11-08 21:36:42 +01:00
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./export-to-serenade.ps1 Computer
2021-12-09 16:19:09 +01:00
⏳ Found 534 PowerShell scripts...
⏳ Writing custom JavaScript file: C:\Users\Markus\.serenade\scripts\PowerShell.js...
✔️ Exported to Serenade with wake word "Computer" in 3 sec
2021-11-08 21:36:42 +01:00
```
## Notes
2022-02-10 09:01:07 +01:00
Author: Markus Fleschutz / License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of export-to-serenade.ps1*