PowerShell/docs/cd-docs.md
2024-11-20 11:52:20 +01:00

68 lines
1.4 KiB
Markdown

The *cd-docs.ps1* Script
===========================
This PowerShell script changes the working directory to the documents folder.
Parameters
----------
```powershell
/home/markus/Repos/PowerShell/scripts/cd-docs.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./cd-docs
📂C:\Users\Markus\Documents
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Sets the working directory to the documents folder
.DESCRIPTION
This PowerShell script changes the working directory to the documents folder.
.EXAMPLE
PS> ./cd-docs
📂C:\Users\Markus\Documents
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
if ($IsLinux) {
$path = Resolve-Path "~/Documents"
} else {
$path = [Environment]::GetFolderPath('MyDocuments')
}
if (-not(Test-Path "$path" -pathType container)) {
throw "Documents folder at 📂$path doesn't exist (yet)"
}
Set-Location "$path"
"📂$path"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:51:50)*