Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
dce44dc
fix internal variables
mdowst Jun 12, 2024
ea9c69b
refactor galore
mdowst Jan 29, 2026
e4b207f
Stop tracking bin folder
mdowst Jan 31, 2026
bed4839
add menu and auto run
mdowst Jan 31, 2026
8457a0c
ui refactor
mdowst Feb 1, 2026
6dfbfa6
Add script execution
mdowst Feb 2, 2026
b802a09
pester tests
mdowst Feb 3, 2026
f99d436
automate Pester tests
mdowst Feb 4, 2026
4ce42d8
clean up build
mdowst Feb 5, 2026
3f21712
add note migration
mdowst Feb 5, 2026
43d380b
update import and export
mdowst Feb 7, 2026
ac23c0f
update build validation
mdowst Feb 7, 2026
afbdc52
add github actions
mdowst Feb 7, 2026
94d3503
build updates
mdowst Feb 7, 2026
6ba2d12
action fixes
mdowst Feb 7, 2026
ad8e093
build fix
mdowst Feb 7, 2026
e00036b
build fix
mdowst Feb 7, 2026
498e4a9
build fix
mdowst Feb 7, 2026
688f624
build fix
mdowst Feb 7, 2026
5ebf381
update help
mdowst Feb 7, 2026
9d90a6a
add script file support
mdowst Feb 7, 2026
cfd3012
update tests
mdowst Feb 7, 2026
a7fd90e
update tests
mdowst Feb 7, 2026
67500b2
update tests
mdowst Feb 7, 2026
29cebf2
update tests
mdowst Feb 7, 2026
b8b9711
update tests
mdowst Feb 7, 2026
b50a050
update tests
mdowst Feb 7, 2026
1b909b3
update tests
mdowst Feb 8, 2026
f320154
update tests
mdowst Feb 8, 2026
8d7a407
update tests
mdowst Feb 8, 2026
11fe459
update tests
mdowst Feb 8, 2026
45d9101
update tests
mdowst Feb 8, 2026
bad79f2
update tests
mdowst Feb 9, 2026
7f5faf0
update tests
mdowst Feb 9, 2026
343d553
update tests
mdowst Feb 9, 2026
b1dd2f7
remove alias default
mdowst Feb 9, 2026
e627d79
update note setting
mdowst Feb 13, 2026
c586d8b
update console
mdowst Feb 15, 2026
d473715
console updates
mdowst Feb 15, 2026
4bc8bcf
search not working
mdowst Feb 15, 2026
5bdc346
more console updates
mdowst Feb 16, 2026
3b5bfe2
Add Get-PSNoteMenu
mdowst Feb 16, 2026
5ac727b
add remote store support
mdowst Feb 17, 2026
b39f341
update remote catalogs
mdowst Feb 17, 2026
1c838b1
add remote catalog tests
mdowst Feb 17, 2026
1b2cfc6
update help and documents
mdowst Feb 17, 2026
3da7466
fix build test
mdowst Feb 17, 2026
a4a7d82
update Search parameter
mdowst Feb 17, 2026
09cd642
documentation
mdowst Feb 18, 2026
5ee709b
updated help
mdowst Feb 19, 2026
ff38792
doc updates
mdowst Feb 19, 2026
98a2e28
update help
mdowst Feb 19, 2026
2469184
updated tests
mdowst Feb 19, 2026
3972e78
refactor NOte to Name
mdowst Feb 19, 2026
5eae58d
refactor name
mdowst Feb 19, 2026
cdfd236
final doc updates
mdowst Feb 19, 2026
4d6fd91
docs
mdowst Feb 19, 2026
168f33c
update tests
mdowst Feb 19, 2026
7a9bc07
update tests
mdowst Feb 19, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: build module

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build-module:
name: Run build and upload artifacts
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
with:
fetch-tags: true
fetch-depth: 0

- name: Install Modules
shell: pwsh
run: |
Set-PSRepository PSGallery -InstallationPolicy Trusted
Install-Module ModuleBuilder,PSScriptAnalyzer,EZOut
Install-Module Pester -MinimumVersion 5.5.0

- name: Run build
shell: pwsh
run: |
$Version = git describe --tags --abbrev=0
Write-Host "Version : $Version"
.\tools\build.ps1 -Version $Version

- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: psnotes-build
path: bin

- name: Build Tests
shell: pwsh
run: .\tools\tests-build.ps1

- name: Build Report
uses: dorny/test-reporter@v2
if: ${{ !cancelled() }}
with:
name: Build Tests
path: 'bin/*.TestResults.xml'
reporter: java-junit

test-module:
needs: build-module
name: Test Module
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
path: bin
pattern: psnotes-build
merge-multiple: true
- run: ls -R bin

- name: Install Modules
shell: pwsh
run: |
Set-PSRepository PSGallery -InstallationPolicy Trusted
Install-Module Pester -MinimumVersion 5.5.0
Install-Module PSScriptAnalyzer

- name: Unit Tests
shell: pwsh
run: .\tools\tests.ps1

- name: Test Report
uses: dorny/test-reporter@v2
if: ${{ !cancelled() }}
with:
name: Pester Tests
path: 'bin/*.TestResults.xml'
reporter: java-junit
8 changes: 5 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Publish/APIKey.json
Publish/PSNotes/
*.code-workspace
*.code-workspace
bin/
Documentation/demos/*
.vscode/*
*/APIKey.json
25 changes: 0 additions & 25 deletions Documentation/Commands.MD

This file was deleted.

84 changes: 84 additions & 0 deletions Documentation/Commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
document type: module
Help Version: 1.0.0.0
HelpInfoUri:
Locale: en-US
Module Guid: 040757f4-ee7b-4e93-9883-f6a1930b6966
Module Name: PSNotes
ms.date: 02/19/2026
PlatyPS schema version: 2024-05-01
title: PSNotes Module
---

# PSNotes Module

## Description

PSNotes is a PowerShell module that provides a structured, versioned snippet and script library for reusable automation patterns. Create notes with aliases, tags, and metadata to quickly execute, copy, or preview commands. Organize notes into local or remote catalogs, search by name, tag, details, or snippet content, and turn frequently used automation into first-class commands.

## PSNotes

### [ConvertTo-Splatting](ConvertTo-Splatting.md)

Converts an existing PowerShell command into a splatting hashtable and splatted command.

### [Export-PSNote](Export-PSNote.md)

Exports PSNotes to a JSON file for backup or sharing.

### [Get-CommandSplatting](Get-CommandSplatting.md)

Generates a splatting template for a PowerShell command.

### [Get-PSNote](Get-PSNote.md)

Retrieves PSNotes from the note store by listing or searching.

### [Get-PSNoteAlias](Get-PSNoteAlias.md)

Resolves a PSNote by alias and outputs, copies, or executes its content.

### [Get-PSNoteMenu](Get-PSNoteMenu.md)

Displays an interactive, paged console menu for browsing and selecting PSNotes.

### [Get-RemoteCatalog](Get-RemoteCatalog.md)

Gets remote catalogs registered with PSNotes.

### [Import-PSNote](Import-PSNote.md)

Imports PSNotes from a JSON export file into the local note store.

### [Import-RemoteCatalog](Import-RemoteCatalog.md)

Registers a remote PSNotes catalog or imports it as a local catalog.

### [Initialize-PSNoteStore](Initialize-PSNoteStore.md)

Initializes the PSNotes store and required supporting files.

### [Move-PSNote](Move-PSNote.md)

Moves one or more PSNotes to a different catalog.

### [New-PSNote](New-PSNote.md)

Creates a new PSNote for storing reusable snippets or script references.

### [Remove-PSNote](Remove-PSNote.md)

Removes one or more PSNotes from the note store.

### [Remove-RemoteCatalog](Remove-RemoteCatalog.md)

Removes a remote catalog registration from PSNotes.

### [Set-PSNote](Set-PSNote.md)

Updates an existing PSNote or creates it if it does not already exist.

### [Update-PSNoteStore](Update-PSNoteStore.md)

Updates PSNotes catalogs to the latest format.

96 changes: 0 additions & 96 deletions Documentation/ConvertTo-Splatting.MD

This file was deleted.

Loading