Skip to content

Commit fa2ef60

Browse files
committedMay 5, 2022
doc: add sub-directory READMEs
1 parent 35d4984 commit fa2ef60

File tree

6 files changed

+80
-28
lines changed

6 files changed

+80
-28
lines changed
 

‎Modules/README.md

+49-28
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,55 @@
11
# PowerShell Modules
22

3-
This directory (~/Documents/PowerShell/Modules) represents the *Current User, All Hosts* `$PSModulePath`. The installed modules are backed up into a simple `JSON` file: [modules.json](modules.json) and created via [modules.ps1](modules.ps1).
3+
## Overview
4+
5+
This directory (~/Documents/PowerShell/Modules) represents the *Current User, All Hosts* `$PSModulePath` where PowerShell modules are installed under the `CurrentUser` Scope (i.e. `-Scope CurrentUser`).
6+
7+
*Note that my personal development modules I created or am in the process of developing are housed under the [Dev](../Dev) directory.*
8+
9+
## Module Management
10+
11+
I manage my modules using a custom [modules.json](modules.json) / [modules.yml](modules.yml) configuration file for easy backups and bootstrapping of installations.
12+
13+
The installed modules are backed up into a simple `JSON` file: [modules.json](modules.json) and created via [modules.ps1](modules.ps1).
414

515
## Installed Modules
616

7-
- [modules.json](modules.json)
8-
9-
```powershell
10-
➜ cat Modules/modules.json | jq
11-
[
12-
"7Zip4Powershell",
13-
"AU",
14-
"BurntToast",
15-
"ChocolateyGet",
16-
"Evergreen",
17-
"Foil",
18-
"oh-my-posh",
19-
"posh-git",
20-
"Posh-Sysmon",
21-
"powershell-yaml",
22-
"psake",
23-
"PSEverything",
24-
"PSFzf",
25-
"PSProfiler",
26-
"PSScriptTools",
27-
"PSWriteColor",
28-
"Terminal-Icons",
29-
"WindowsCompatibility",
30-
"WslInterop",
31-
"ZLocation"
32-
]
33-
```
17+
- [**BuildHelpers**](BuildHelpers)
18+
- [**Pester**](Pester)
19+
- [**Plaster**](Plaster)
20+
- [**platyPS**](platyPS)
21+
- [**posh-git**](posh-git)
22+
- [**powershell-yaml**](powershell-yaml)
23+
- [**PowerShellBuild**](PowerShellBuild)
24+
- [**PowerShellGet**](PowerShellGet)
25+
- [**Profiler**](Profiler)
26+
- [**ps2exe**](ps2exe)
27+
- [**psake**](psake)
28+
- [**PSDepend**](PSDepend)
29+
- [**PSReadLine**](PSReadLine)
30+
- [**PSWindowsUpdate**](PSWindowsUpdate)
31+
- [**PSWriteColor**](PSWriteColor)
32+
- [**Stucco**](Stucco)
33+
- [**Terminal-Icons**](Terminal-Icons)
34+
- [**VSCodeBackup**](VSCodeBackup)
35+
- [**WingetTools**](WingetTools)
36+
- [**WTToolBox**](WTToolBox)
37+
- [**ZLocation**](ZLocation)
38+
39+
## Other Useful Modules
40+
41+
Here's a list of other useful modules I have encountered and experimented with in the past for reference:
3442

43+
- 7Zip4Powershell
44+
- AU
45+
- BurntToast
46+
- ChocolateyGet
47+
- Evergreen
48+
- Foil
49+
- Posh-Sysmon
50+
- PSEverything
51+
- PSFzf
52+
- PSProfiler
53+
- PSScriptTools
54+
- WindowsCompatibility
55+
- WslInterop

‎Profile/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
# Profile Directory
3+
4+
- [**aliases**](aliases)
5+
- [**completions**](completions)
6+
- [**functions**](functions)

‎Profile/aliases/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# PowerShell Aliases

‎Profile/completions/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
tree_title: "Shell Completions"
3+
---
4+
5+
<!-- generated by markdown-notes-tree -->
6+
7+
# Shell Completions
8+
9+
- [aws.ps1](aws.ps1): AWS CLI
10+
- [choco.ps1](choco.ps1): Chocolatey Package Manager
11+
- [docker.ps1](docker.ps1): Docker
12+
- [dotnet.ps1](dotnet.ps1): DotNet
13+
- [ffsend.ps1](ffsend.ps1): FFSend
14+
- [gh-cli.ps1](gh-cli.ps1): GitHub CLI
15+
- [git-cliff.ps1](git-cliff.ps1): Git-Cliff
16+
- [oh-my-posh.ps1](oh-my-posh.ps1): oh-my-posh
17+
- [s-search.ps1](s-search.ps1): s search utility
18+
- [scoop.ps1](scoop.ps1): Scoop Package Manager
19+
- [spotify.ps1](spotify.ps1): Spotify
20+
- [winget.ps1](winget.ps1): WinGet Package Manager
21+
- [yq.ps1](yq.ps1): yq YAML parser

‎Profile/functions/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Custom PowerShell Functions

‎Scripts/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
# Scripts

0 commit comments

Comments
 (0)
Please sign in to comment.