maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated the examples so that they work on Linux.

Browse source
This commit is contained in:
Jianyun Tao 2016-07-13 19:18:29 -07:00
parent ff0b90b574
commit 8ce9f2fd71
3 changed files with 104 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
docs/learning-powerShell/debugging-from-commandline.md
View file

@ -25,45 +25,46 @@ Write-Host "$result Celsius"
- Open a [PowerShell editor](learning-powershell.md#powershell-editor)
- Save the above code snippet to a file, let's say "test.ps1"
- Go to your command-line PowerShell
- Clear existing breakpoints if any
```PowerShell
Get-PSBreakpoint | Remove-PSBreakpoint
PS /home/jen/debug>Get-PSBreakpoint | Remove-PSBreakpoint
```
- Use **Set-PSBreakpoint** cmdlet to set a debug breakpoint, say set it to line 5
```PowerShell
PS C:\Test>Set-PSBreakpoint -Line 5 -Script .\test.ps1
PS /home/jen/debug>Set-PSBreakpoint -Line 5 -Script ./test.ps1
ID Script Line Command Variable Action
-- ------ ---- ------- -------- ------
5 test.ps1 5
0 test.ps1 5
```
- Run the script, test.ps1. As we have set a breakpoint, it is expected the program will break into the debugger at the line 5.
```PowerShell
PS C:\Test> .\test.ps1
PS /home/jen/debug> ./test.ps1
Input a temperature in Fahrenheit: 80
Hit Line breakpoint on 'C:\Test\test.ps1:5'
Hit Line breakpoint on '/home/jen/debug/test.ps1:5'
At C:\Test\test.ps1:5 char:1
At /home/jen/debug/test.ps1:5 char:1
+ $celsius = $celsius / 1.8
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
[DBG]: PS C:\Test>>
[DBG]: PS /home/jen/debug>>
```
- The PowerShell prompt has been changed to **[DBG]: PS C:\Test>>** as you may noticed. This means
- The PowerShell prompt has been changed to **[DBG]: PS /home/jen/debug>>** as you may noticed. This means
we have entered into the debug mode. To watch the variables like $celsius, simply type $celsius as below.
- To exit from the debugging, type **"q"**
- To get help for the debugging commands, simple type **"?"**
```PowerShell
[DBG]: PS C:\Test>> $celsius
[DBG]: PS /home/jen/debug>> $celsius
48
[DBG]: PS C:\Test>> $fahrenheit
[DBG]: PS /home/jen/debug>> $fahrenheit
80
[DBG]: PS PS C:\Test>> ?
[DBG]: PS /home/jen/debug>> ?
s, stepInto Single step (step into functions, scripts, etc.)
v, stepOver Step to next statement (step over functions, scripts, etc.)
@ -87,17 +88,17 @@ At C:\Test\test.ps1:5 char:1
For instructions about how to customize your debugger prompt, type "help about_prompt".
[DBG]: PS C:\Test>> s
At C:\Test\test.ps1:6 char:1
[DBG]: PS /home/jen/debug>> s
At PS /home/jen/debug/test.ps1:6 char:1
+ $celsius
+ ~~~~~~~~
[DBG]: PS C:\Test>> $celsius
[DBG]: PS /home/jen/debug>> $celsius
26.6666666666667
[DBG]: PS C:\Test>> $fahrenheit
[DBG]: PS /home/jen/debug>> $fahrenheit
80
[DBG]: PS C:\Test>> q
PS C:\Test>
[DBG]: PS /home/jen/debug>> q
PS /home/jen/debug>
```
@ -106,13 +107,13 @@ PS C:\Test>
- Clear existing breakpoints if any
```PowerShell
PS C:\Test>Get-PSBreakpoint | Remove-PSBreakpoint
PS /home/jen/debug>Get-PSBreakpoint | Remove-PSBreakpoint
```
- Use **Set-PSBreakpoint** cmdlet to set a debug breakpoint, say set it to line 5
```PowerShell
PS C:\Test>Set-PSBreakpoint -Variable "celsius" -Mode write -Script .\test.ps1
PS /home/jen/debug>Set-PSBreakpoint -Variable "celsius" -Mode write -Script ./test.ps1
```
@ -123,14 +124,14 @@ PS C:\Test>
```PowerShell
PS C:\Test> .\test.ps1
PS /home/jen/debug> ./test.ps1
Input a temperature in Fahrenheit: 80
Hit Variable breakpoint on 'C:\Test\test.ps1:$celsius' (Write access)
Hit Variable breakpoint on '/home/jen/debug/test.ps1:$celsius' (Write access)
At C:\Test\test.ps1:3 char:1
At /home/jen/debug/test.ps1:3 char:1
+ $celsius = $fahrenheit - 32
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
[DBG]: PS C:\Test>> l
[DBG]: PS /home/jen/debug>> l
1: function ConvertFahrenheitToCelsius([double] $fahrenheit)
@ -145,22 +146,22 @@ At C:\Test\test.ps1:3 char:1
10: Write-Host "$result Celsius"
[DBG]: PS C:\Test>> $celsius
[DBG]: PS /home/jen/debug>> $celsius
48
[DBG]: PS C:\Test>> v
At C:\Test\test.ps1:4 char:1
[DBG]: PS /home/jen/debug>> v
At /home/jen/debug/test.ps1:4 char:1
+ $celsius = $celsius / 1.8
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
[DBG]: PS C:\Test>> v
Hit Variable breakpoint on 'C:\Test\test.ps1:$celsius' (Write access)
[DBG]: PS /home/jen/debug>> v
Hit Variable breakpoint on '/home/jen/debug/test.ps1:$celsius' (Write access)
At C:\Test\test.ps1:4 char:1
At /home/jen/debug/test.ps1:4 char:1
+ $celsius = $celsius / 1.8
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
[DBG]: PS C:\Test>> $celsius
[DBG]: PS /home/jen/debug>> $celsius
26.6666666666667
[DBG]: PS C:\Test>> q
PS C:\Test>
[DBG]: PS /home/jen/debug>> q
PS /home/jen/debug>
```

137
docs/learning-powerShell/powershell-beginners-guide.md
View file

@ -14,45 +14,47 @@ Getting Familiar with PowerShell Commands
As mentioned above PowerShell commands is designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc. Let’s exercise some of the basic PowerShell commands also known as **cmdlets**.
Please note that we will use the PowerShell prompt sign **PS />** in the following examples as it shows on Linux.
It looks like **PS C:\>** on Windows.
**1. Get-Process**: displays the processes running on your system.
By default, you will get data back similar to the following:
``` PowerShell
PS C:\>Get-Process
PS />Get-Process
Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
------- ------ ----- ----- ----- ------ -- -----------
147 11 2108 9316 ...82 0.02 12 notepad
174 12 4276 1460 ...53 3.56 309 cmd
121 9 1580 3096 ...85 3.94 8620 svchost
2168 374 448940 321504 820 867.39 1209 iexplore
Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName
------- ------ ----- ----- ------ -- -----------
- - - 1 0.012 12 bash
- - - 21 20.220 449 powershell
- - - 11 61.630 8620 code
- - - 74 403.150 1209 firefox
…
```
Only interested in the instance of notepad that are running on your computer? Try this:
Only interested in the instance of firefox process that are running on your computer? Try this:
```PowerShell
PS C:\> Get-Process -Name notepad
PS /> Get-Process -Name firefox
Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
------- ------ ----- ----- ----- ------ -- -----------
147 11 2108 9316 ...82 0.02 12 notepad
Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName
------- ------ ----- ----- ------ -- -----------
- - - 74 403.150 1209 firefox
```
Want to get back more than one process? Then just specify process names, separating with commas. For example,
```PowerShell
PS C:\> Get-Process -Name notepad, iexplore
Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
------- ------ ----- ----- ----- ------ -- -----------
1753 247 418220 194960 991 385.97 1748 iexplore
144 11 2152 9320 ...82 0.08 30004 notepad
PS /> Get-Process -Name firefox, powershell
Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName
------- ------ ----- ----- ------ -- -----------
- - - 74 403.150 1209 firefox
- - - 21 20.220 449 powershell
```
**2. Clear-Host**: Clears the display in the command window
```PowerShell
PS C:\> Get-Process
PS C:\> Clear-Host
PS /> Get-Process
PS /> Clear-Host
```
Type too much just for clearing the screen? Here is how the alias can help.
@ -60,108 +62,109 @@ Type too much just for clearing the screen? Here is how the alias can help.
To find the available aliases, you can type below cmdlet:
```PowerShell
PS C:\> Get-Alias
PS /> Get-Alias
CommandType Name
----------- ----
…
Alias cat -> Get-Content
Alias cd -> Set-Location
Alias cls -> Clear-Host
Alias cp -> Copy-Item
Alias clv -> Clear-Variable
Alias copy -> Copy-Item
Alias dir -> Get-ChildItem
Alias gc -> Get-Content
Alias gmo -> Get-Module
Alias man -> help
Alias rm -> Remove-Item
Alias ls -> Get-ChildItem
Alias ri -> Remove-Item
Alias type -> Get-Content
…
As you can see "cls" is an alias of Clear-Host. Now try it:
PS C:\> Get-Process
PS C:\> cls
PS /> Get-Process
PS /> cls
```
**4. cd - Set-Location**: change your current working directory
```PowerShell
PS C:\> Set-Location C:\test
PS C:\test>
PS /> Set-Location /home
PS /home>
```
**5. ls or dir - Get-ChildItem**: list all items in the specified location
```PowerShell
Get all files under the current directory:
PS C:\test> Get-ChildItem
PS /> Get-ChildItem
Get all files under the current directory as well as its subdirectories:
PS C:\test> dir -Recurse
PS /> cd $home
PS /home/jen> dir -Recurse
List all files with file extension "txt".
PS C:\test> ls –Path *.txt -Recurse -Force
PS /> cd $home
PS /home/jen> dir –Path *.txt -Recurse
```
**6. New-Item**: Create a file
```PowerShell
An empty file is created if you type the following:
PS C:\test> New-Item -Path c:\test\test.txt
PS /home/jen> New-Item -Path ./test.ps1
Directory: C:\test
Directory: /home/jen
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/7/2016 7:17 PM 0 test.txt
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/7/2016 7:17 PM 0 test.ps1
```
You can use the **-value** parameter to add some data to your file. For example, the following command adds the phrase "Hello World" as a file content to the test.txt. Because the test.txt file exists already, we use **-force** parameter to replace the existing content.
You can use the **-value** parameter to add some data to your file. For example, the following command adds the phrase "Write-Host 'Hello There'" as a file content to the test.ps1. Because the test.txt file exists already, we use **-force** parameter to replace the existing content.
```PowerShell
PS C:\test> New-Item -Path c:\test\test.txt -Value "Hello World!" -force
PS /home/jen> New-Item -Path ./test.ps1 -Value "Write-Host 'hello there'" -force
Directory: C:\test
Directory: /home/jen
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/7/2016 7:19 PM 12 test.txt
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/7/2016 7:19 PM 24 test.ps1
```
There are other ways to add some data to a file, for example, you can use Set-Content to set the file contents:
```PowerShell
PS C:\test>Set-Content -Path c:\test\test.txt -Value "Hello World too!"
PS /home/jen>Set-Content -Path ./test.ps1 -Value "Write-Host 'hello there again!'"
```
Or simply use ">>" as below:
Or simply use ">" as below:
```
# create an empty file
"" > empty.txt
# set "hello world!!!" as content of text.txt file
"hello world!!!" > test.txt
"hello world!!!" > empty.txt
```
The pound sign (#) above is used for comments in PowerShell.
**7. type, cat - Get-Content**: get the content of an item
**7. type - Get-Content**: get the content of an item
```PowerShell
PS C:\>Get-Content -Path "C:\Test\test.txt"
PS C:\>type -Path "C:\Test\test.txt"
PS /home/jen> Get-Content -Path ./test.ps1
PS /home/jen> type -Path ./test.ps1
Hello World!
"Write-Host 'hello there again!'"
```
**8. rm, del - Remove-Item**: delete a file or folder
**8. del - Remove-Item**: delete a file or folder
This cmdlet will delete the file c:\test\test.txt:
This cmdlet will delete the file /home/jen/test.ps1:
```PowerShell
PS C:\test> Remove-Item c:\test\test.txt
PS /home/jen> Remove-Item ./test.ps1
```
**9. Exit**: - to exit the PowerShell session, type "exit"
```PowerShell
PS C:\test> exit
PS /home/jen> exit
```
Need Help?
@ -169,16 +172,16 @@ Need Help?
The most important command in PowerShell is possibly the Get-Help, which allows you to quickly learn PowerShell without having to surfing around the Internet. The Get-Help cmdlet also shows you how PowerShell commands work with examples.
PS C:\>**Get-Help**
PS />**Get-Help**
You can use this cmdlet to get help with any PowerShell commands.
PS C:\>**Get-Help -Name Get-Process**
PS />**Get-Help -Name Get-Process**
It shows the syntax and other technical information of the Get-Process cmdlet.
PS C:\>**Get-Help -Name Get-Process -Examples**
PS />**Get-Help -Name Get-Process -Examples**
It displays the examples how to use the Get-Process cmdlet.
If you use **-full** parameter, i.e., "Get-Help -Name Get-Process -Full", it will display more technical information.
@ -190,33 +193,33 @@ Discover All Commands Available on Your System
You want to discover what PowerShell cmdlets available on your system. Simple, just run "Get-Command" as below.
PS C:\> **Get-Command**
PS /> **Get-Command**
If you want to know whether a particular cmdlet exists on your system, you can do something like below:
PS C:\> **Get-Command Get-Process**
PS /> **Get-Command Get-Process**
If you want to know the syntax of Get-Process cmdlet, type
PS C:\> **Get-Command Get-Process -Syntax**
PS /> **Get-Command Get-Process -Syntax**
If you want to know how to sue the get-process, type
PS C:\> **Get-Help Get-Process -example**
PS /> **Get-Help Get-Process -example**
PowerShell Pipeline '|'
----
Sometimes when you run Get-ChildItem or "dir", you want to get a list of files in a descending order. To archive that, type:
```PowerShell
PS C:\> dir | sort -Descending
PS /home/jen> dir | sort -Descending
```
Say you want to get the largest file in a directory
```PowerShell
PS C:\> dir | sort -Property length -Descending | Select-Object -First 1
PS /home/jen> dir | Sort-Object -Property Length -Descending | Select-Object -First 1
Directory: C:\
Directory: /home/jen
Mode LastWriteTime Length Name
@ -227,7 +230,7 @@ Mode LastWriteTime Length Name
How to Create and Run PowerShell scripts
----
- You can use ISE, VS Code, or any favorite editor to create a PowerShell script and save the script with a .ps1 file extension (helloworld.ps1 in the example)
- To run the script, cd to your current folder and type .\helloworld.ps1
- To run the script, cd to your current folder and type ./helloworld.ps1
See [Running PowerShell Scripts Is as Easy as 1-2-3] [run-ps] for more details.

2
docs/learning-powerShell/using-vscode.md
View file

@ -42,7 +42,7 @@ Editing with VS Code
Debugging with VS Code
----
- Open a file folder (**File->Open Folder**) where contains the PowerShell modules or scripts you have written already and want to debug. In this example, we saved helloworld.ps1 under c:\test\debug. Thus we select the "debug" folder and open it in VS Code.
- Open a file folder (**File->Open Folder**) where contains the PowerShell modules or scripts you have written already and want to debug. In this example, we saved helloworld.ps1 under home/jen/debug. Thus we select the "debug" folder and open it in VS Code.
- Creating the Debug Configuration (launch.json)