Functions

​

Overview

​

Function Directory Structure

~/.config/powershell/functions/
├── archive.ps1        # Extract archives
├── backup.ps1         # Create timestamped backups
├── greeting.ps1       # Display system info on startup
├── jqc.ps1           # Parse JSON from clipboard
├── mkcd.ps1          # Make directory and cd into it
├── navigation.ps1    # Quick directory navigation
├── reload.ps1        # Reload/restart PowerShell
├── rfv.ps1           # Ripgrep + fzf + editor integration
└── wsl-helpers.ps1   # WSL integration functions

​

Loading Mechanism

$functionsDir = "$HOME\.config\powershell\functions"

if (Test-Path $functionsDir) {
    Get-ChildItem -Path $functionsDir -Filter "*.ps1" | 
        ForEach-Object { 
            . $_.FullName 
        }
}

# Invoke greeting if available
if (Get-Command Show-Greeting -ErrorAction SilentlyContinue) {
    Show-Greeting
}

​

How It Works

​

Function Categories

​

File Operations

• mkcd - Create directory and navigate into it
• backup / bak - Create timestamped backups
• extract / unpack - Extract various archive formats

​

Search & Navigation

• rfv - Ripgrep + fzf + editor integration for code search
• ~, desk, docs, dl, dev, conf - Quick directory jumps
• ., …, … - Parent directory navigation
• - - Return to previous directory

​

JSON Processing

• jqc - Parse JSON from clipboard with jq

​

Shell Management

• reload - Reload PowerShell profile without restarting
• restart - Restart PowerShell with fresh process

​

WSL Integration

• wsl-here - Open current Windows directory in WSL
• Copy-ToWSL - Copy files from Windows to WSL
• Copy-FromWSL - Copy files from WSL to Windows
• wslrun - Execute commands in WSL

​

Adding New Functions

1. Create a new .ps1 file in ~/.config/powershell/functions/
2. Define your function with proper documentation
3. Optionally add aliases for convenience
4. Reload your profile or restart PowerShell

​

Function Template

function My-CustomFunction {
    <#
    .SYNOPSIS
    Brief description of what the function does
    
    .DESCRIPTION
    More detailed description if needed
    
    .EXAMPLE
    My-CustomFunction -Param1 "value"
    Description of what this example does
    
    .EXAMPLE
    mycmd "value"  # Using alias
    Another example
    #>
    param(
        [Parameter(Mandatory=$true, Position=0)]
        [string]$Param1,
        
        [Parameter(Position=1)]
        [string]$Param2 = "default"
    )
    
    # Function implementation
    Write-Host "Processing: $Param1"
}

# Optional: Add convenient alias
Set-Alias -Name mycmd -Value My-CustomFunction

​

Function Organization Strategies

​

Single Purpose Files

mkcd.ps1    → mkcd function
backup.ps1  → Backup-Item function + aliases
jqc.ps1     → jqc function

​

Grouped Functions

~, desk, docs, dl, dev, conf  # Quick jumps
.., ..., ....                 # Parent navigation
-                             # Previous directory

Enter-WSL, wsl-here           # WSL access
Copy-ToWSL, Copy-FromWSL      # File copying
Invoke-WSL                    # Command execution

​

Function Discovery

Get-Command -CommandType Function | Where-Object Source -eq ''

Get-Content function:mkcd

Get-Help Backup-Item -Full

​

Load Order Considerations

• After environment setup (10-environment.ps1)
• After aliases (20-aliases.ps1)
• After tool integrations (30-tools.ps1)
• Before prompt configuration (60-prompt.ps1)

• Use environment variables like $env:EDITOR
• Reference tools configured in earlier modules
• Access modern CLI tools (bat, fzf, ripgrep, etc.)

​

Benefits

​

See Also

• Custom Functions - Detailed documentation for each function
• Profile Structure - How the module system works
• Aliases - Command shortcuts and abbreviations