forked from jdhitsolutions/PSScriptTools
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSet-ConsoleColor.yml
More file actions
117 lines (117 loc) · 2.59 KB
/
Copy pathSet-ConsoleColor.yml
File metadata and controls
117 lines (117 loc) · 2.59 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
examples:
- name: Example 1
preCode: ''
code: PS C:\> Set-ConsoleColor -foreground Yellow -background DarkGray -clear
postCode: Set the console color to yellow text and on a dark gray background.
inputs:
- type: None
description: ''
links:
- href: https://github.com/jdhitsolutions/PSScriptTools/blob/master/docs/Set-ConsoleColor.md
text: 'Online Version:'
- href: Set-ConsoleTitle.md
text: Set-ConsoleTitle
module:
name: PSScriptTools
name: Set-ConsoleColor
notes: 'Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/'
optionalParameters:
- name: Background
aliases:
- bg
defaultValue: None
description: Specify a background console color
parameterValueGroup:
- Black
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gray
- DarkGray
- Blue
- Green
- Cyan
- Red
- Magenta
- Yellow
- White
pipelineInput: False
position: 1
type: ConsoleColor
- name: ClearScreen
aliases:
- cls
defaultValue: None
description: Clear the console host screen.
parameterValueGroup: []
pipelineInput: False
position: Named
type: SwitchParameter
- name: Confirm
aliases:
- cf
defaultValue: None
description: Prompts you for confirmation before running the cmdlet.
parameterValueGroup: []
pipelineInput: False
position: Named
type: SwitchParameter
- name: Foreground
aliases:
- fg
defaultValue: None
description: Specify a foreground console color
parameterValueGroup:
- Black
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gray
- DarkGray
- Blue
- Green
- Cyan
- Red
- Magenta
- Yellow
- White
pipelineInput: False
position: 0
type: ConsoleColor
- name: Passthru
aliases: []
defaultValue: None
description: Display foreground and background color values
parameterValueGroup: []
pipelineInput: False
position: Named
type: SwitchParameter
- name: WhatIf
aliases:
- wi
defaultValue: None
description: Shows what would happen if the cmdlet runs. The cmdlet is not run.
parameterValueGroup: []
pipelineInput: False
position: Named
type: SwitchParameter
outputs:
- type: None
description: ''
requiredParameters: []
remarks: You can use this command to modify the PowerShell console's foreground and/or background color. Note that if you are running the PSReadline module, that module has commands, like Set-PSReadLineOption, that you can use to modify your console.
summary: Set the PowerShell console color
syntaxes:
- parameters:
- Foreground
- Background
- ClearScreen
- Confirm
- Passthru
- WhatIf