Skip to content

Latest commit

 

History

History
1561 lines (1111 loc) · 24.2 KB

File metadata and controls

1561 lines (1111 loc) · 24.2 KB

Function Reference

Auto-generated documentation Last updated: 2026-08-27 17:04:34 Total functions: 127

Table of Contents

Applications

ConvertFrom-ScoopStatusOutput

Signature:

function ConvertFrom-ScoopStatusOutput {
[CmdletBinding()]
param(
        [Parameter(ValueFromPipeline)]
        [AllowEmptyString()]
        [object[]]$Output
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

ConvertFrom-WingetUpgradeOutput

Signature:

function ConvertFrom-WingetUpgradeOutput {
[CmdletBinding()]
param([object[]]$Output)
}

Source: Core\Apps\UpdateAppsHelper.ps1

Get-ScoopPackageBlockers

Signature:

function Get-ScoopPackageBlockers {
param(
        [string]$Name,
        [object[]]$Process = @(Get-Process -ErrorAction SilentlyContinue)
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

Get-UvSelfUpdateCommandPath

Signature:

function Get-UvSelfUpdateCommandPath {
param(
        [string]$ActiveCommandPath,
        [string]$LegacyStandalonePath
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

Get-WingetExecutable

Signature:

function Get-WingetExecutable

Source: Core\Apps\UpdateAppsHelper.ps1

Initialize-PowerShellGallery

Signature:

function Initialize-PowerShellGallery

Source: Core\Apps\UpdateAppsHelper.ps1

Initialize-UpdateLog

Signature:

function Initialize-UpdateLog

Description:

Initialize logging

Source: Core\Apps\Updates\SystemUpdater.ps1

Invoke-RequiredModuleRepair

Signature:

function Invoke-RequiredModuleRepair

Source: Core\Apps\UpdateAppsHelper.ps1

Test-CommandExist

Signature:

function Test-CommandExist {
param([string]$Command)
}

Source: Core\Apps\UpdateAppsHelper.ps1

Test-WingetManagedCommandPath

Signature:

function Test-WingetManagedCommandPath {
param([string]$CommandPath)
}

Source: Core\Apps\UpdateAppsHelper.ps1

Test-WingetPackageInstalled

Signature:

function Test-WingetPackageInstalled {
param([string]$Id)
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Cargo

Signature:

function Update-Cargo {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Chezmoi

Signature:

function Update-Chezmoi {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Choco

Signature:

function Update-Choco {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Composer

Signature:

function Update-Composer {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Conda

Signature:

function Update-Conda {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Description:

Additional Development Tools

Source: Core\Apps\UpdateAppsHelper.ps1

Update-DotnetTool

Signature:

function Update-DotnetTool {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Fzf

Signature:

function Update-Fzf {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Gcloud

Signature:

function Update-Gcloud {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Gem

Signature:

function Update-Gem {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-GoTools

Signature:

function Update-GoTools {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Homebrew

Signature:

function Update-Homebrew {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-NodeEnvironment

Signature:

function Update-NodeEnvironment {
[CmdletBinding(SupportsShouldProcess)]
param(
        [switch]$CleanCache,
        [switch]$ForceReinstall
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Npm

Signature:

function Update-Npm {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Pipx

Signature:

function Update-Pipx {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-PowerShellModule

Signature:

function Update-PowerShellModule {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-PowerShellRuntime

Signature:

function Update-PowerShellRuntime {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-PythonEnvironment

Signature:

function Update-PythonEnvironment {
[CmdletBinding(SupportsShouldProcess)]
param(
        [switch]$CleanCache
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Scoop

Signature:

function Update-Scoop {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Starship

Signature:

function Update-Starship {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-StoreApp

Signature:

function Update-StoreApp {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-System

Signature:

function Update-System {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Description:

Main update function with visual progress

Source: Core\Apps\Updates\SystemUpdater.ps1

Update-Uv

Signature:

function Update-Uv {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Vcpkg

Signature:

function Update-Vcpkg {
[CmdletBinding(SupportsShouldProcess)]
param(
        [string[]]$VcpkgRoots = @('C:\vcpkg', 'D:\opt\vcpkg', 'C:\tools\vcpkg')
    )
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-VSCodeExtension

Signature:

function Update-VSCodeExtension {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-WindowsSystem

Signature:

function Update-WindowsSystem {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-Winget

Signature:

function Update-Winget {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Update-WSL

Signature:

function Update-WSL {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Source: Core\Apps\UpdateAppsHelper.ps1

Write-UpdateErrorLog

Signature:

function Write-UpdateErrorLog {
param($ErrorMessage, $Source, $LogFile)
}

Description:

Error handling function

Source: Core\Apps\Updates\SystemUpdater.ps1

Write-UpdateHeader

Signature:

function Write-UpdateHeader {
param([string]$Title)
}

Description:

Helper function to write section headers

Source: Core\Apps\UpdateAppsHelper.ps1

Write-UpdateLog

Signature:

function Write-UpdateLog {
param($Message, $LogFile)
}

Description:

Logging function

Source: Core\Apps\Updates\SystemUpdater.ps1

Write-UpdateStatus

Signature:

function Write-UpdateStatus {
param(
        [string]$Message,
        [ValidateSet('Info', 'Success', 'Warning', 'Error')]
        [string]$Status = 'Info'
    )
}

Description:

Helper function to write status messages

Source: Core\Apps\UpdateAppsHelper.ps1

Core

Initialize-ModuleInstallationEnvironment

Signature:

function Initialize-ModuleInstallationEnvironment

Source: Core\ModuleInstaller.ps1

Install-RequiredModule

Signature:

function Install-RequiredModule {
[CmdletBinding()]
param(
        [ValidateNotNullOrEmpty()]
        [string[]]$Name = @($requiredModules.Keys)
    )
}

Source: Core\ModuleInstaller.ps1

Save-ModuleCache

Signature:

function Save-ModuleCache

Source: Core\ModuleInstaller.ps1

Test-ModuleInstalled

Signature:

function Test-ModuleInstalled {
param(
        [string]$ModuleName,
        [string]$MinVersion
    )
}

Source: Core\ModuleInstaller.ps1

Test-ModulePathHealthy

Signature:

function Test-ModulePathHealthy {
param([string]$ModulePath)
}

Source: Core\ModuleInstaller.ps1

Write-ModuleCacheEntry

Signature:

function Write-ModuleCacheEntry {
param(
        [string]$ModuleName,
        [object]$Module
    )
}

Source: Core\ModuleInstaller.ps1

Profile

Disable-FullPSReadLine

Signature:

function Disable-FullPSReadLine

Description:

Provide a function to disable PSReadLine features if needed

Source: Microsoft.PowerShell_profile.ps1

Enable-TerminalIcon

Signature:

function Enable-TerminalIcon

Description:

Provide an explicit enable function for Terminal-Icons so nothing related to it is created at startup

Source: Microsoft.PowerShell_profile.ps1

Initialize-CachedToolInit

Signature:

function Initialize-CachedToolInit {
param(
        [string]$ToolName,
        [scriptblock]$InitCommand,
        [string]$CacheBaseName,
        [string]$ConfigPath
    )
}

Description:

Reusable fingerprint-based cache for tool init scripts

Source: Microsoft.PowerShell_profile.ps1

Install-Dependency

Signature:

function Install-Dependency {
param(
        [switch]$All,
        [switch]$PackageManagers,
        [switch]$CliTools,
        [switch]$Modules,
        [string]$Tool
    )
}

Source: Microsoft.PowerShell_profile.ps1

Measure-Block

Signature:

function Measure-Block {
param(
        [string]$Name,
        [scriptblock]$Block
    )
}

Source: Microsoft.PowerShell_profile.ps1

System

_fzf_get_path_using_fd

Signature:

function _fzf_get_path_using_fd

Source: Core\System\fzf.ps1

_fzf_get_path_using_rg

Signature:

function _fzf_get_path_using_rg

Source: Core\System\fzf.ps1

_fzf_open_path

Signature:

function _fzf_open_path {
param (
    [Parameter(Mandatory=$true)]
    [string]$input_path
  )
}

Source: Core\System\fzf.ps1

Clear-All

Signature:

function Clear-All {
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
param()
}

Source: Core\System\clean.ps1

Clear-Disk

Signature:

function Clear-Disk

Source: Core\System\clean.ps1

Clear-RecycleBin

Signature:

function Clear-RecycleBin {
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
param()
}

Description:

Disk cleanup utilities Source: https://www.geeksforgeeks.org/disk-cleanup-using-powershell-scripts/

Source: Core\System\clean.ps1

Clear-TempData

Signature:

function Clear-TempData {
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
param()
}

Source: Core\System\clean.ps1

cma

Signature:

function cma {
param (
        [string[]] $files
    )
}

Source: Core\System\chezmoi.ps1

cmc

Signature:

function cmc {
param (
        [string] $msg
    )
}

Source: Core\System\chezmoi.ps1

cmp

Signature:

function cmp

Source: Core\System\chezmoi.ps1

cms

Signature:

function cms

Source: Core\System\chezmoi.ps1

dirs

Signature:

function dirs

Description:

Recursive file listing (equivalent of dir /s /b)

Source: Core\System\linuxLike.ps1

Env:

Signature:

function Env:

Source: Core\System\linuxLike.ps1

fdg

Signature:

function fdg

Source: Core\System\fzf.ps1

HKCU:

Signature:

function HKCU:

Source: Core\System\linuxLike.ps1

HKLM:

Signature:

function HKLM:

Description:

Drive shortcuts

Source: Core\System\linuxLike.ps1

n

Signature:

function n

Source: Core\System\linuxLike.ps1

Remove-FzfSelectedPath

Signature:

function Remove-FzfSelectedPath {
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
param([Parameter(Mandatory)][string]$Path)
}

Source: Core\System\fzf.ps1

rgg

Signature:

function rgg

Source: Core\System\fzf.ps1

sha256

Signature:

function sha256

Description:

Linux-like utility functions for PowerShell

Source: Core\System\linuxLike.ps1

Tools

Get-DependencyInstallerWinget

Signature:

function Get-DependencyInstallerWinget

Description:

region Installation Functions

Source: tools\install-dependencies.ps1

Initialize-NuGetProvider

Signature:

function Initialize-NuGetProvider

Source: tools\install-dependencies.ps1

Install-AiTools

Signature:

function Install-AiTools

Source: tools\install-dependencies.ps1

Install-CliTools

Signature:

function Install-CliTools

Source: tools\install-dependencies.ps1

Install-DevRuntimes

Signature:

function Install-DevRuntimes

Source: tools\install-dependencies.ps1

Install-NpmPackages

Signature:

function Install-NpmPackages

Source: tools\install-dependencies.ps1

Install-PackageManagers

Signature:

function Install-PackageManagers

Source: tools\install-dependencies.ps1

Install-PipPackages

Signature:

function Install-PipPackages

Source: tools\install-dependencies.ps1

Install-PowerShellModules

Signature:

function Install-PowerShellModules

Source: tools\install-dependencies.ps1

Install-Tool

Signature:

function Install-Tool {
param(
        [string]$Name,
        [string]$Command,
        [string]$ScoopPackage,
        [string]$ScoopBucket = 'main',
        [string]$WingetId,
        [string]$ChocoPackage
    )
}

Source: tools\install-dependencies.ps1

Install-WithChoco

Signature:

function Install-WithChoco {
param([string]$Package)
}

Source: tools\install-dependencies.ps1

Install-WithScoop

Signature:

function Install-WithScoop {
param(
        [string]$Package,
        [string]$Bucket = 'main'
    )
}

Source: tools\install-dependencies.ps1

Install-WithWinget

Signature:

function Install-WithWinget {
param([string]$PackageId)
}

Source: tools\install-dependencies.ps1

Sync-SessionPath

Signature:

function Sync-SessionPath

Description:

region Helper Functions

Source: tools\install-dependencies.ps1

Test-SudoAvailable

Signature:

function Test-SudoAvailable

Source: tools\install-dependencies.ps1

Write-Status

Signature:

function Write-Status {
param(
        [string]$Message,
        [ValidateSet('Info', 'Success', 'Warning', 'Error', 'Header')]
        [string]$Type = 'Info'
    )
}

Source: tools\install-dependencies.ps1

Utilities

..

Signature:

function ..

Description:

Navigation aliases and utilities

Source: Core\Utils\unified_aliases.ps1

...

Signature:

function ...

Source: Core\Utils\unified_aliases.ps1

.4

Signature:

function .4

Source: Core\Utils\unified_aliases.ps1

Clear-DnsCache

Signature:

function Clear-DnsCache

Description:

Networking Utilities

Source: Core\Utils\unified_aliases.ps1

Connect-Proxmox

Signature:

function Connect-Proxmox {
param(
    [string]$Target = $env:PROXMOX_SSH_TARGET,
    [int]$Port = $(if ($env:PROXMOX_SSH_PORT) { $env:PROXMOX_SSH_PORT } else { 22 })
  )
}

Description:

SSH helper for Proxmox. Configure PROXMOX_SSH_TARGET (for example, user@host) and optionally PROXMOX_SSH_PORT outside the repository.

Source: Core\Utils\unified_aliases.ps1

df

Signature:

function df

Description:

System utilities

Source: Core\Utils\unified_aliases.ps1

Expand-CustomArchive

Signature:

function Expand-CustomArchive {
param (
        [Parameter(Mandatory=$true)]
        [string]$File,
        [string]$Folder
    )
}

Source: Core\Utils\FileSystemUtils.ps1

Expand-MultipleArchives

Signature:

function Expand-MultipleArchives {
param([string[]]$Files)
}

Source: Core\Utils\FileSystemUtils.ps1

Find-File

Signature:

function Find-File {
param(
        [Parameter(Position=0)]
        [string]$pattern = "*",
        [string]$path = ".",
        [switch]$recurse,
        [int]$depth = 3
    )
}

Description:

Search utilities for PowerShell profile

Source: Core\Utils\SearchUtils.ps1

Find-PowerShellCommand

Signature:

function Find-PowerShellCommand {
param([string]$name)
}

Source: Core\Utils\SearchUtils.ps1

Find-String

Signature:

function Find-String

Source: Core\Utils\unified_aliases.ps1

Get-ClipboardContent

Signature:

function Get-ClipboardContent

Source: Core\Utils\unified_aliases.ps1

Get-CommandPath

Signature:

function Get-CommandPath

Source: Core\Utils\unified_aliases.ps1

Get-Font

Signature:

function Get-Font {
param (
    $regex
  )
}

Source: Core\Utils\unified_aliases.ps1

Get-FormattedUptime

Signature:

function Get-FormattedUptime

Source: Core\Utils\CommonUtils.ps1

Get-ProcessByName

Signature:

function Get-ProcessByName

Source: Core\Utils\unified_aliases.ps1

Get-PubIP

Signature:

function Get-PubIP

Source: Core\Utils\CommonUtils.ps1

head

Signature:

function head {
param($Path, $n = 10)
}

Source: Core\Utils\unified_aliases.ps1

Initialize-Editor

Signature:

function Initialize-Editor

Description:

Editor detection and configuration - lazy loaded

Source: Core\Utils\unified_aliases.ps1

Invoke-GitPull

Signature:

function Invoke-GitPull

Source: Core\Utils\unified_aliases.ps1

Invoke-GitPush

Signature:

function Invoke-GitPush

Source: Core\Utils\unified_aliases.ps1

la_with_eza

Signature:

function la_with_eza

Description:

this should be the same as ls -al no tree

Source: Core\Utils\unified_aliases.ps1

ll

Signature:

function ll

Source: Core\Utils\unified_aliases.ps1

ll_with_eza

Signature:

function ll_with_eza

Source: Core\Utils\unified_aliases.ps1

ls_with_eza

Signature:

function ls_with_eza {
param([Parameter(ValueFromRemainingArguments = $true)]$params)
}

Source: Core\Utils\unified_aliases.ps1

lt_with_eza

Signature:

function lt_with_eza

Source: Core\Utils\unified_aliases.ps1

New-DirectoryAndEnter

Signature:

function New-DirectoryAndEnter {
[CmdletBinding(SupportsShouldProcess)]
param([string]$dir)
}

Description:

File system utilities for PowerShell profile

Source: Core\Utils\FileSystemUtils.ps1

New-File

Signature:

function New-File {
[CmdletBinding(SupportsShouldProcess)]
param($file)
}

Description:

File and directory management (mkcd/New-DirectoryAndEnter defined in FileSystemUtils.ps1)

Source: Core\Utils\unified_aliases.ps1

Restart-BIOS

Signature:

function Restart-BIOS {
[CmdletBinding(SupportsShouldProcess)]
param()
}

Description:

Test-IsAdmin defined in CommonUtils.ps1

Source: Core\Utils\unified_aliases.ps1

Search-FileContent

Signature:

function Search-FileContent {
param(
        [Parameter(Mandatory=$true)]
        [string]$pattern,
        [string]$path = ".",
        [string]$filter = "*.*",
        [switch]$caseSensitive
    )
}

Source: Core\Utils\SearchUtils.ps1

Set-ClipboardContent

Signature:

function Set-ClipboardContent {
[CmdletBinding(SupportsShouldProcess)]
param($content)
}

Description:

Clipboard Utilities

Source: Core\Utils\unified_aliases.ps1

Set-EnvironmentVariable

Signature:

function Set-EnvironmentVariable {
[CmdletBinding(SupportsShouldProcess)]
param($name, $value)
}

Source: Core\Utils\unified_aliases.ps1

Stop-ProcessByName

Signature:

function Stop-ProcessByName {
[CmdletBinding(SupportsShouldProcess)]
param($name)
}

Source: Core\Utils\unified_aliases.ps1

sysinfo

Signature:

function sysinfo

Description:

Quick Access to System Information

Source: Core\Utils\unified_aliases.ps1

tail

Signature:

function tail {
param($Path, $n = 10)
}

Source: Core\Utils\unified_aliases.ps1

Test-IsAdmin

Signature:

function Test-IsAdmin

Source: Core\Utils\CommonUtils.ps1

uptime

Signature:

function uptime

Description:

System information and utilities (Get-PubIP, Get-FormattedUptime defined in CommonUtils.ps1)

Source: Core\Utils\unified_aliases.ps1

v

Signature:

function v

Description:

Lazy editor alias that initializes on first use

Source: Core\Utils\unified_aliases.ps1