README
¶
Turbogit (tug)
tug is a cli tool built to help you deal with your day-to-day git work. tug enforces conventions (e.g. The Conventional Commits) without overwhelming you. tug is your friend.
Usage
Improve your git workflow.
Usage:
tug [command]
Available Commands:
branch Create a new branch
check Check the history to follow conventional commit
commit Commit staging area
completion Generate completion script
help Help about any command
log Shows the commit logs.
tag Create a tag
version Print current version
Flags:
--config string config file (default is $HOME/.config/tug/tug.toml)
-h, --help help for tug
Use "tug [command] --help" for more information about a command.
Installation
turbogit needs libgit2 >= 1.1.0 on your system. Some package manager will handle its installation automatically
macOS
turbogit is available on MacPorts and Homebrew.
Macports (preferred)
install
sudo port install turbogit
upgrade
sudo port selfupdate && sudo port upgrade turbogit
Homebrew
install
brew tap b4nst/homebrew-tap
brew install turbogit
upgrade
brew upgrade turbogit
Linux
Debian/Ubuntu
Install and upgrade:
Download the .deb file from the releases page
sudo apt install ./turbogit_*_linux_amd64.deb
Fedora
Install and upgrade:
Download the .rpm file from the releases page
sudo dnf install ./turbogit_*_linux_amd64.rpm
Centos
Install and upgrade:
Download the .rpm file from the releases page
sudo yum localinstall ./turbogit_*_linux_amd64.rpm
openSUSE/SUSE
Install and upgrade:
Download the .rpm file from the releases page
sudo zypper in ./turbogit_*_linux_amd64.rpm
Alpine
Install and upgrade:
Download the .apk file from the releases page
apk add --allow-untrusted ./turbogit_*_linux_amd64.apk
Windows
Since git2go refactor, tug is not available as a Windows package anymore. Please check #48.
turbogit is available via scoop.
scoop bucket add scoop-bucket https://github.com/b4nst/scoop-bucket.git
scoop install turbogit
Other platforms
Prebuilt binary available from the release page.
Shell completion
Fish
tug completion fish | source
To load completions for each session, execute once:
tug completion fish > ~/.config/fish/completions/tug.fish
Zsh
source <(tug completion zsh)
To load completions for each session, execute once:
tug completion zsh > "${fpath[1]}/_tug"
Bash
source <(tug completion bash)
To load completions for each session, execute once: Linux
tug completion bash > /etc/bash_completion.d/tug
MacOS
tug completion bash > /usr/local/etc/bash_completion.d/tug
Contributing
Thanks for getting involved in turbogit ❤️! Please read the Contributing guide, it will help you make your awesome contribution.
Documentation
¶
Overview ¶
Copyright © 2020 banst
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories