Quickstart

How to install a powerup and use it.

Install a powerup

Powerups can be installed from either npm or git repos:

pup install npm:@liolocs/powerup-hello-world
pup install git@github.com:liolocs/powerup-hello-world.git

This will save the powerup in the global ~/.powerups folder

Refer to the install api for more info.

Use a powerup

Using a powerup will apply its coding instructions in your current working directory.

  1. Use the powerup-hello-world:
bash
pup use powerup-hello-world --target-dir=./hello-world-test
  1. Resulting in the following output:
bash
Created: index.ts
Created: package.json

āœ“ Powerup powerup-hello-world was successfully used in /Users/<user>/<path>/hello-world-test
  • Refer to the powerup-hello-world page for more details on the powerup.
  • Refer to the use api for more info on the use command

Remove a powerup

You can remove the powerup by using just the powerup name:

pup uninstall powerup-hello-world
pup uninstall git:@github.com/liolocs/powerup-hello-world

or by using the full package source:

pup uninstall npm:@liolocs/powerup-hello-world
pup uninstall git:@github.com/liolocs/powerup-hello-world

Like install, it removes from the global store unless you pass --local or -l.