A punchy PowerShell framework.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
custom
plugins
themes
.gitignore
Kapow.psm1
README.md
example.profile.ps1
install.ps1
update.ps1

README.md

Kapow!

A punchy PowerShell framework, similar to Oh my Zsh! and Bash it.

But why?

The PowerShell needs some love. Seriously.

Features

  • Short hand aliases
  • Useful scripts
  • Tab completion (requires PowerShell 3.0)
  • Colorful themes

Prerequisites

Kapow! requires atleast PowerShell 2.0 in order to run. You can find out which version you're using by running $PSVersionTable.PsVersion.

Installation

Set up the PowerShell

First you need to make sure that you can actually execute scripts by running Get-ExecutionPolicy in the PowerShell. If the output doesn't say RemoteSigned or Unrestricted you need to run the PowerShell as an Administrator and execute the following command: Set-ExecutionPolicy RemoteSigned.

Install Kapow!

Clone the repository and run the ìnstall.ps1 script by executing the following command: .\install.ps1. This will copy and create the Kapow.psm1 file to the WindowsPowerShell\Modules folder. You can then import the module by adding Import-Module Kapow to either your Windows.PowerShell_profile.ps1 or profile.ps1 file.

Set your default settings

The next step is to set the $KapowDefaultPath variable in the Kapow.psm1 file to point to the right folder. The default path is C:\Git\kapow. This is incredibly important since everything will be sourced from that particular folder!

Change the $KapowDefaultHome if you're planning on using a theme that's replacing your "home" folder with a tilde (~) and set the default prompt theme by changing the $KapowDefaultTheme variable.

The $KapowDefaultEditor variable is primarily used for the edit plugin, so if you're not planning to use it leave it blank. The same thing is true for the $KapowEnableGitColors. Set it to $false if you're not going to use the git plugin.

The last thing you need to do is to choose which plugins to use. Look around in the plugins and then add them to the $KapowDefaultPlugins array in the Kapow.psm1 file and you're done!

Optional: install a better console

The look of the PowerShell itself leaves a lot to be desired. If you want a more fine tuned experience I highly recommend that you install Console2, or better yet, ConsoleZ.

Screenshots

Bashlet theme

Bashlet theme

Crunchy theme

Crunchy theme

Crunchier theme

Crunchier theme

Inon theme

Inon theme

Punchy theme

Punchy theme

Simple theme

Simple theme

Acknowledgements

License

The MIT License (MIT)

Copyright (c) 2013 Ellen Gummesson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.