Skip to content

Commit fca77b7

Browse files
brianarybrianary
committed
📝 Update readme
1 parent 07e0c07 commit fca77b7

File tree

5 files changed

+214
-14
lines changed

5 files changed

+214
-14
lines changed

‎README.md‎

Lines changed: 7 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/Get-SimpleSchTasks.ps1.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
external help file: -help.xml
3+
Module Name:
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SimpleSchTasks.ps1
9+
10+
## SYNOPSIS
11+
Returns simple scheduled task info.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-SimpleSchTasks.ps1 [[-TaskName] <String[]>] [[-TaskPath] <String[]>] [-NonInteractive]
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
{{ Fill in the Description }}
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
Get-SimpleSchTasks.ps1 -TaskPath \ -NonInteractive
28+
```
29+
30+
Returns a simplified list of tasks for the local system that are not set to run interactively.
31+
32+
## PARAMETERS
33+
34+
### -TaskName
35+
Specifies an array of one or more names of a scheduled task.
36+
You can use "*" for a wildcard character query.
37+
38+
```yaml
39+
Type: String[]
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: False
44+
Position: 1
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -TaskPath
51+
Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace.
52+
You can use "*" for a wildcard character query.
53+
You can use \ for the root folder.
54+
To specify a full TaskPath you need to include the leading and trailing \ *.
55+
If you do not specify a path, the cmdlet uses the root folder.
56+
57+
```yaml
58+
Type: String[]
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: False
63+
Position: 2
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -NonInteractive
70+
Exclude tasks that are set to run interactively, include only tasks with credentials set.
71+
72+
```yaml
73+
Type: SwitchParameter
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: False
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -ProgressAction
85+
{{ Fill ProgressAction Description }}
86+
87+
```yaml
88+
Type: ActionPreference
89+
Parameter Sets: (All)
90+
Aliases: proga
91+
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### CommonParameters
100+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
101+
102+
## INPUTS
103+
104+
## OUTPUTS
105+
106+
## NOTES
107+
108+
## RELATED LINKS

‎docs/Select-ScriptCommands.ps1.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
external help file: -help.xml
3+
Module Name:
4+
online version: https://learn.microsoft.com/dotnet/api/system.management.automation.language.parser.parsefile
5+
schema: 2.0.0
6+
---
7+
8+
# Select-ScriptCommands.ps1
9+
10+
## SYNOPSIS
11+
Returns the commands used by the specified script.
12+
13+
## SYNTAX
14+
15+
```
16+
Select-ScriptCommands.ps1 [[-Path] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```
26+
Select-ScriptCommands.ps1 Select-ScriptCommands.ps1
27+
```
28+
29+
CommandType Name Version Source
30+
----------- ---- ------- ------
31+
Cmdlet Out-Null 7.5.0.500 Microsoft.PowerShell.Core
32+
Cmdlet Where-Object 7.5.0.500 Microsoft.PowerShell.Core
33+
Cmdlet Select-Object 7.0.0.0 Microsoft.PowerShell.Utility
34+
Cmdlet Get-Command 7.5.0.500 Microsoft.PowerShell.Core
35+
Cmdlet Resolve-Path 7.0.0.0 Microsoft.PowerShell.Management
36+
Filter Get-ScriptCommands
37+
38+
## PARAMETERS
39+
40+
### -Path
41+
A script file path (wildcards are accepted).
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: False
49+
Position: 1
50+
Default value: None
51+
Accept pipeline input: True (ByValue)
52+
Accept wildcard characters: False
53+
```
54+
55+
### -ProgressAction
56+
{{ Fill ProgressAction Description }}
57+
58+
```yaml
59+
Type: ActionPreference
60+
Parameter Sets: (All)
61+
Aliases: proga
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
72+
73+
## INPUTS
74+
75+
### System.String containing the path to a script file to parse.
76+
## OUTPUTS
77+
78+
### System.Management.Automation.CommandInfo for each command parsed from the file.
79+
## NOTES
80+
81+
## RELATED LINKS
82+
83+
[https://learn.microsoft.com/dotnet/api/system.management.automation.language.parser.parsefile](https://learn.microsoft.com/dotnet/api/system.management.automation.language.parser.parsefile)
84+
85+
[Get-Command]()
86+

‎docs/index.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Pester tests status](https://github.com/brianary/scripts/actions/workflows/pester.yml/badge.svg)][pester.yml]
44
[![Pester tests results](https://gist.githubusercontent.com/brianary/4642e5c804aa1b40738def5a7c03607a/raw/badge.svg)][pester.yml]
5-
[![Pester tests coverage](https://img.shields.io/badge/Pester_coverage-3505_%E2%80%B1-orange
5+
[![Pester tests coverage](https://img.shields.io/badge/Pester_coverage-3485_%E2%80%B1-orange
66
red)](https://github.com/brianary/scripts/tree/main/test)
77
[![GitHub license badge](https://badgen.net/github/license/brianary/Scripts?icon=github)](https://mit-license.org/ "MIT License")
88
[![GitHub stars badge](https://badgen.net/github/stars/brianary/Scripts?icon=github)](https://github.com/brianary/scripts/stargazers "Stars")
@@ -30,7 +30,7 @@ Scripts from the [Scripts](https://github.com/brianary/Scripts/) repo.
3030
- **[Get-CommandPath.ps1](Get-CommandPath.ps1.md)**: Locates a command.
3131
- **[Hide-Command.ps1](Hide-Command.ps1.md)**: Make a command unavailable.
3232
- **[Invoke-CommandWithParams.ps1](Invoke-CommandWithParams.ps1.md)**: Execute a command by using matching dictionary entries as parameters.
33-
- **[Use-Command.ps1](Use-Command.ps1.md)**: Checks for the existence of the given command, and adds if missing and a source is defined.
33+
- &#x1F199; **[Use-Command.ps1](Use-Command.ps1.md)**: Checks for the existence of the given command, and adds if missing and a source is defined.
3434

3535
### Configuration
3636

@@ -50,10 +50,10 @@ Scripts from the [Scripts](https://github.com/brianary/Scripts/) repo.
5050

5151
- **[Export-SecretVault.ps1](Export-SecretVault.ps1.md)**: Exports secret vault content.
5252
- **[Get-CachedCredential.ps1](Get-CachedCredential.ps1.md)**: Return a credential from secure storage, or prompt the user for it if not found.
53-
- &#x1F195; **[Get-SecretDetails.ps1](Get-SecretDetails.ps1.md)**: Returns secret info from the secret vaults, including metadata as properties.
53+
- **[Get-SecretDetails.ps1](Get-SecretDetails.ps1.md)**: Returns secret info from the secret vaults, including metadata as properties.
5454
- **[Import-SecretVault.ps1](Import-SecretVault.ps1.md)**: Imports secrets into secret vaults.
5555
- **[Remove-CachedCredential.ps1](Remove-CachedCredential.ps1.md)**: Removes a credential from secure storage.
56-
- &#x1F199; **[Save-Secret.ps1](Save-Secret.ps1.md)**: Sets a secret in a secret vault with metadata.
56+
- **[Save-Secret.ps1](Save-Secret.ps1.md)**: Sets a secret in a secret vault with metadata.
5757

5858
### Data
5959

@@ -232,6 +232,7 @@ Scripts from the [Scripts](https://github.com/brianary/Scripts/) repo.
232232
- **[ConvertFrom-CimInstance.ps1](ConvertFrom-CimInstance.ps1.md)**: Convert a CimInstance object to a PSObject.
233233
- **[ConvertTo-ICalendar.ps1](ConvertTo-ICalendar.ps1.md)**: Converts supported objects (Scheduled Tasks) to the RFC 5545 iCalendar format.
234234
- **[Copy-SchTasks.ps1](Copy-SchTasks.ps1.md)**: Copy scheduled jobs from another computer to this one, using a GUI list to choose jobs.
235+
- &#x1F195; **[Get-SimpleSchTasks.ps1](Get-SimpleSchTasks.ps1.md)**: Returns simple scheduled task info.
235236
- **[Restore-SchTasks.ps1](Restore-SchTasks.ps1.md)**: Imports from a single XML file into the local Scheduled Tasks.
236237

237238
### Scripts
@@ -241,6 +242,7 @@ Scripts from the [Scripts](https://github.com/brianary/Scripts/) repo.
241242
- **[Optimize-Help.ps1](Optimize-Help.ps1.md)**: Cleans up comment-based help blocks by fully unindenting and capitalizing dot keywords.
242243
- **[Rename-Script.ps1](Rename-Script.ps1.md)**: Renames all instances of a script, and updates any usage of it.
243244
- **[Repair-ScriptStyle.ps1](Repair-ScriptStyle.ps1.md)**: Accepts justifications for script analysis rule violations, fixing the rest using Invoke-ScriptAnalysis.
245+
- &#x1F195; **[Select-ScriptCommands.ps1](Select-ScriptCommands.ps1.md)**: Returns the commands used by the specified script.
244246

245247
### Search and replace
246248

‎test/README.md‎

Lines changed: 7 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)