kaoengine CLI-Tools for Powershell

Effortless Powershell Scripting!

Automatically handles the start location path avoiding errors when the script is located on subfolders or when it's called from different paths.
By default errors do not close command line windows, so you can display better feedback to your users.
Great to write CLI utils for your projects without needing to write additional code.
One script to rule them all: Powershell is Multiplatform!

Instructions

You can download the latest stable version using the following PowerShell command:

Invoke-WebRequest -Uri https://raw.githubusercontent.com/kaoengine/powershell-cli-tool/master/_kaoengineCLI.ps1 -OutFile '_kaoengineCLI.ps1'

Under the same folder where _kaoengineCLI.ps1 was downloaded, create a ps1 file using the following snippet.

. $PSScriptRoot/_kaoengineCLI.ps1

Function Invoke-Script {
    # Add your commands here
    # ...
}

Start-Cli -Title 'My Title' -Filename 'FileToSearch'

Run your script!

Examples

Suppose that your util files are located under utils/ folder, the correct script to Run npm install will be something like this:

. $PSScriptRoot/_kaoengineCLI.ps1

Function Invoke-Script {
    npm install
}

# You can omit -AlternativePath as '..' is its default value
Start-Cli -Title 'Install JS APP' -Filename 'package.json' -AlternativePath '..'

More examples

Create a script to Install Ruby Gems and Bundler
Create a script to Run a Docker Compose

Summarizing: Define your script to automate any given task. Add Filename parameter so that kaoengine CLI knows exactly where the execution should start.

Included utilities

Read-Json-File

Given a path loads a file as a Json into an object.

### JsonFile.json
[
  {
    "Name": "Hello",
    "Active": true
  },
  {
    "Name": "World",
    "Active": false
  }
]

### SampleReadJson.ps1
. $PSScriptRoot/_kaoengineCLI.ps1

Function Invoke-Script {
    $users = Read-Json-File -Path './JsonFile.json'
    foreach ($user in $users) {
        Write-Host $user.Name
        Write-Host $user.Active
    }
}

Start-Cli -Title 'SampleReadJson' -Filename 'JsonFile.json'

Start-Cli params

Title: short text describing your task.
Filename: kaoengine CLI will lookup for this file to set the location where the script execution should start.
AlternativePath: by default it is '..'. If the Filename wasn't found in the current location, the script will loockup in this path.

It's common to create your scripts under a folder in your repo (usually utils/, scripts/ or tools), Filename and AlternativePath will grant that the script is always executed in the desired folder no matter where the execution started or where your script is located.
MaxPopsOnExit: by default it is 10. If you are doing additional push's to different locations you can adjust this parameter to ensure that your script will end on the original location.
SkipIntro: by default is false. Hides the intro information.
SkipLicense: by default is false. Hides the license information that appears on the script execution.

More info

Installing and using Powershell: See Wikilaterus entry

trkhanh / poc-powershell-cli-tool