0.1.0 ⢠Published 5 years ago
git-bunny v0.1.0
š Table of Contents
- š Table of Contents
 - š§ About
 - š Getting Started
 - š Usage
 - āļø Built Using
 - āļø Authors
 - š Acknowledgements
 
š§ About
š Getting Started
gBunny requires:
How to install
npm install -g git-bunnyš Usage
Once istalled, gBunny can be run with the command gbunny or with one of its shorthands if they don't conflict with existing aliases (g and gb).
There are 2 ways to run commands: 1) by starting a new REPL session 2) by passing sub-commands to gbunny
$ gbunny <command>|<git-command>Use case examples
About the REPL
To start a new session cd to your repository directory and run:
$ gbunnyOnce the REPL is started you can run gBunny and Git sub-commands omitting the git command.
Type h to see the list of available commands.
Change the prompt theme in the REPL
At the moment there are only 2 available themes:
- agnoster (requires Powerline font)
 - arrow
 
Themes can be changed with the following command:
git config --global "gbunny.repltheme" "THEME_NAME"Prompt explanation
$ gBunny ⯠my-project ⯠master ⯠ā1 ā1 ~0 +2 -0 ā ~1 +0 -1 !- gBunny Indicator of a gBunny REPL session
 - my-project The repository name
 - master The current branch.
- When green it means there are no changed files
 - Orange means there are changed files
 
 - ā1 ā1 Changes to pull and push
 - ~0 +2 -0 ā ~1 +0 -1 ! Changes in the index and in the work tree
- ~ Modified files
 - + Added files
 - - Deleted files
 - ! Conflicted files
 
 
āļø Built Using
āļø Authors
- @imfaber - Idea & development
 
š Acknowledgements
Inspired by
0.1.0
5 years ago