0.5.11 • Published 8 years ago
@thebespokepixel/guppy-cli v0.5.11
guppy-cli
Install git-hooks for use with git-guppy.
Special git-hooks that invoke git-guppy can be installed using the commandline utility or by requiring guppy-cli as a dependency and calling the provided methods.
Commandline Usage
Install with npm install -g guppy-cli
Usage: guppy <hookname>|all|standard|flow|everything [-d <path>]
Commands:
hookname Install a git-hook by name, for a list, see --hooks
standard Install all available standard git-hooks. (Use caution!)
flow Install all available git-flow-hooks. (Use caution!)
all Installs all available hooks! (Use caution!)
Options:
-d, --dest Destination path for git-hook (default: ./.git/hooks/)
--hooks Print a complete list of available git-hooks
-h, --help Show help [boolean]
--version Show version number [boolean]
Examples:
guppy pre-commit
guppy pre-commit -d some/where
guppy all
Existing git-hooks will be backed up the first time. If a backup already exists, it will not be overwritten. The extension .guppy
will be appended to the filename of existing git-hooks when backing up.
Pre-packaged installers
For convenience, each type of git-hook has an installer package.
Install any package as a dev-dependency to install the associated git-hook automatically.
npm install --save-dev <package>
- guppy-applypatch-msg
- guppy-commit-msg
- guppy-post-applypatch
- guppy-post-checkout
- guppy-post-commit
- guppy-post-merge
- guppy-post-receive
- guppy-post-rewrite
- guppy-post-update
- guppy-pre-applypatch
- guppy-pre-auto-gc
- guppy-pre-commit
- guppy-pre-push
- guppy-pre-rebase
- guppy-pre-receive
- guppy-prepare-commit-msg
- guppy-update
This fork also includes the following hooks for git-flow-avh
- guppy-filter-flow-hotfix-finish-tag-message
- guppy-filter-flow-hotfix-start-version
- guppy-filter-flow-release-branch-tag-message
- guppy-filter-flow-release-finish-tag-message
- guppy-filter-flow-release-start-version
- guppy-pre-flow-feature-start
- guppy-pre-flow-feature-pull
- guppy-pre-flow-feature-track
- guppy-pre-flow-feature-publish
- guppy-pre-flow-feature-finish
- guppy-pre-flow-feature-delete
- guppy-post-flow-feature-start
- guppy-post-flow-feature-pull
- guppy-post-flow-feature-track
- guppy-post-flow-feature-publish
- guppy-post-flow-feature-finish
- guppy-post-flow-feature-delete
- guppy-pre-flow-release-start
- guppy-pre-flow-release-branch
- guppy-pre-flow-release-track
- guppy-pre-flow-release-publish
- guppy-pre-flow-release-finish
- guppy-pre-flow-release-delete
- guppy-post-flow-release-start
- guppy-post-flow-release-branch
- guppy-post-flow-release-track
- guppy-post-flow-release-publish
- guppy-post-flow-release-finish
- guppy-post-flow-release-delete
- guppy-pre-flow-hotfix-start
- guppy-pre-flow-hotfix-finish
- guppy-pre-flow-hotfix-publish
- guppy-pre-flow-hotfix-delete
- guppy-post-flow-hotfix-start
- guppy-post-flow-hotfix-finish
- guppy-post-flow-hotfix-publish
- guppy-post-flow-hotfix-delete
- guppy-post-flow-bugfix-start
- guppy-post-flow-bugfix-pull
- guppy-post-flow-bugfix-track
- guppy-post-flow-bugfix-finish
- guppy-post-flow-bugfix-publish
- guppy-post-flow-bugfix-delete
Dependency Usage
To use guppy-cli as a dependency, install with:
npm install --save guppy-cli
Available methods:
- gup.install(hookname, destination, callback(err, result)) - Install the named hook to destination.
- gup.installAll(destination, callback(err)) - Install all standard hooks to destination.
- gup.installSet(destination, 'all'|'standard'|'flow'|'everything' callback(err)) - Install hook sets to destination.