Getting Started

Welcome to Git-Tool, we hope you'll find it to be an awesome addition to your toolkit and that it'll bring you plenty of smiles. There are a few things you'll need to do to get yourself set up and working and these are covered in each of the Getting Started guides you'll find here.

Tips

This guide is the high-level run-through for anyone familiar with setting up Git-Tool or who likes guessing their way to a conclusion. If you run into trouble or want something more detailed, use the links in each Step.

Step #1: Installation

You can download the latest version of Git-Tool from our GitHub releases page. Pop it into your $PATH and you're good to go!

Tips

At this point, you'll be able to run git-tool to open repositories, create new ones, or manage your weekly scratchpads without any further configuration, however you'll probably want to continue through the remaining steps to get the most out of your setup.

Step #2: Setup

To get the most out of Git-Tool, you should run the setup wizard with git-tool setup. This wizard will guide you through the process of setting up your configuration file and shell autocompletion to ensure you get the most out of Git-Tool.

Step #3: Linking to GitHub

Git-Tool ❤️ GitHub and can automatically create repositories there whenever you run gt new.

To set this up, generate a new Personal Access Token with the repo scope and run the following command to store it in your local keychain.

gt auth gh

Bonus Step: Updating Git-Tool

We update Git-Tool regularly to patch bugs, add features and ensure that any potential security vulnerabilities in Git-Tool or its dependencies are closed as quickly as possible.

You'll find our list of releases on GitHub and can subscribe there for notifications, but the quickest way to update is to run gt update.

Warning

Due to the way Git-Tool runs and updates itself, you'll need to make sure that you close down any shells it has launched before running gt update.