Skip to content

jakehildreth/Stepper

Repository files navigation

The Stepper logo features the word Stepper in a bold, stylized font with a set of stairs ascending diagonally to the right. The design conveys a sense of progress and upward movement, aligning with the tool's purpose of step-by-step automation. The background is plain, ensuring the logo remains the focal point. Font used: https://www.dafont.com/pix.font?fpp=200

Stepper

A cross-platform PowerShell utility module for creating resumable, step-by-step scripts with automatic state persistence.

PowerShell 5.1+ Platform PSGallery License


Quick Start

Install-Module -Name Stepper -Scope CurrentUser -Force

Create a .ps1 script with New-Step blocks:

#Requires -Modules Stepper   # documents the dependency; Stepper enforces this
[CmdletBinding()]            # required for error propagation and -Verbose support
param()

New-Step 'Download Files' {
    Write-Host "Downloading files..."
    # your code here
}

New-Step 'Process Data' {
    Write-Host "Processing data..."
    # your code here
}

New-Step 'Upload Results' {
    Write-Host "Uploading results..."
    # your code here
}

Stop-Stepper   # removes the state file on successful completion

If the script fails inside a New-Step block, the next run resumes at the step that failed. All previously completed steps are skipped!


Demo

Test.ps1.mp4

Created with VHS by Charm.


Learn More


License

MIT License w/Commons Clause - see LICENSE file for details.


Made with 💜 by Jake Hildreth

About

Stepper is a cross-platform PowerShell utility module for creating resumable, step-by-step scripts with automatic state persistence.

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors