Get Started

Installation

Installing Pump is really easy. Just go to our GitHub page, copy the install script, and run it in your terminal.

Once installed, close and reopen your terminal. Then type: help

Pump will prompt you to add your first project. Type the name of your project and hit enter.

If your project is already cloned on your machine, select "yes", then choose the folder where your project is located by choosing the foleder pressing arrow keys right and left and tying enter and confirming the location in the prompt.

Then also confirm your package manager.

Once your project is added, just follow the instructions shown.

Run the command shown on screen (that's the name you gave to your project).

You’ll see it's trying to detect the Node version used by this project if the project has a package.json. Since I have nvm installed (Node Version Manager), I can select from the available Node.js versions and choose the one I want for this project.

Now if I type: help again, I’ll see a list of available commands.

Running npm commands

setup – This command runs "npm run setup" if that script exists, or "npm install" if it doesn't. You can also customize what setup runs in Pump's configuration file pump.zshenv. You can define a custom script in entry PUMP_SETUP or run a shell script.

run – This command runs your app in development mode. It's a shortcut for "npm run dev"

Running git commands

Now let’s say I make a change to my code.

c "my commit" - that creates a Git commit. A shortcut for "git add ." then "git commit -m ..."

push - to push it to the remote repository. A shortcut for "git push"

glog -1 – Shows the latest Git log entry. -1 means one log entry. -10 is the default.

co – Switches branches. Run co -h for help.

main - Switches to main branch.

merge or rebase – For merging or rebasing branches.

-h – Add -h after any command to see more options.

Managing projects

pro -h - will show you more information about the pro function.