project-butler
v1.0.0-beta2
Published
A simple but effective PM for your CLI
Downloads
17
Readme
CLI Project Manager
| Build status master | Build status develop | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | |
Installation
- Install package
npm -g install project-butler
and follow the helper to select your shell - Reload your shell
- DONE. You can use it now by calling
p
Usage
Usage as Videos
Adding and switching between projects
Removing aliases and removing projects
Usage as Documentation
$ p [options] [COMMAND] [args]
Commands:
p | list available projects
p add | adds current directory to projects
p remove project-name | removes an alias (not the whole project)
p cd project-name | opens the given project (explicit version of `p script-name`)
p project-name | opens the given project (shortcut for `p cd`)
p script-name | if inside a project you can trigger a script with this
p --help | show help menu
Why would I choose p cd project
over p project
?
Well since project-butler
is able to run your scripts the following could happen:
You are in your project directory and you call p start
. If your package.json in that directory contains a start
script then project-butler
would NOT search for a global project but run npm run-script start
instead. In this case you could overgo the behaviour by calling p cd start
which would explicitly search for a project instead if needed.
Contribution
There is no official contribution guide yet but feel free to get in touch.