Skip to main content

Installing the CLI

Powertool is currently only supported on Unix systems (MacOS, Linux, WSL, etc). A windows distribution is not planned. If you're on windows, consider using Windows Subsystem for Linux.

Quick Install​

We're still working on a one line install using a script. Stay tuned!

Manual Install​

To run powertool, you'll need bun. You can install bun with

curl -fsSL https://bun.sh/install | bash

Now clone the repo somewhere convenient. I'll assume that you have git installed. I'll put it in my /usr/local/powertool folder:

sudo git clone https://github.com/pwrtool/powertool.git /usr/local/powertool/

You'll then need to add the bin folder to your path. If you put it in your /usr/local/powertool folder, that path would be /usr/local/powertool/bin. You'll want something like the following inm your .bashrc, .profile, .zshrc or whatever:

export PATH=$PATH:/usr/local/powertool/bin

Now ensure that the installation worked properly:

pwrtool --help

This should display a help message that looks like the following:

Usage: pwrtool [options] [command]

Automate every aspect of your workflow

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  install <kit>    Install a tool from Github to your system
  update <kit>     uninstalls and reinstalls a kit to ensure it is up to date
  uninstall <kit>  Uninstall a tool from your system
  test-install     Installs ./install.sh as a kit to the test-kit directory. You can then run
                   `ptx bench/test <tool>` to test your kit. This is primarily useful for
                   developing kits
  info <kit>       Get information about a kit from its ptinfo.yaml file

Installing Kits

It's recommended that you install the pwrtool/std kit. Run the following command:

pwrtool install pwrtool/std

pwrtool install looks for the github repo from the user or organization pwrtool with the name std and clones it. All of the building of the kit is done straight from the source to minimize issues of it not working on different machines.

If you want to know the capabilities of a kit, run pwrtool info:

pwrtool infoo pwrtool/std

This contains tools for building new kits, running those kits, and some basic "hello world" and example stuff.