# 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.

TIP

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 releasesopen in new window page. Pop it into your $PATH, setup a config file, configure your shell and you're good to go!

# $PROFILE.CurrentUserAllHosts

$env:GITTOOL_CONFIG="${env:HOME}/git-tool.yml"

# This adds an alias for Git-Tool so you can simply type "gt"
New-Alias -Name gt -Value git-tool

# This sets up autocomplete support for git-tool and "gt"
Invoke-Expression (&git-tool shell-init powershell)
1
2
3
4
5
6
7
8
9
# ~/.bashrc

export GITTOOL_CONFIG="$HOME/.config/git-tool.yml"

alias gt="git-tool"
eval "$(git-tool shell-init bash)"
1
2
3
4
5
6
# ~/.zshrc

export GITTOOL_CONFIG="$HOME/Library/Preferences/git-tool.yml"

alias gt="git-tool"
eval "$(git-tool shell-init zsh)"
1
2
3
4
5
6

# Step #2: Configuration

Setup your $GITTOOL_CONFIG file with the repository hosting services and apps you want to use, point it at your development directory and Git-Tool will do the rest.

---
directory: "C:\\dev" # CHANGE ME
services:
  - domain: github.com
    website: "https://{{ .Service.Domain }}/{{ .Repo.FullName }}"
    httpUrl: "https://{{ .Service.Domain }}/{{ .Repo.FullName }}.git"
    gitUrl: "[email protected]{{ .Service.Domain }}:{{ .Repo.FullName }}.git"
    default: true
    pattern: "*/*"
apps:
  - name: shell
    command: pwsh # CHANGE ME

features:
  #  Set this to false if you don't want to send crash information to us
  telemetry: true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 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 Tokenopen in new window with the repo scope and run the following command to store it in your local keychain.

gt auth github.com
1

# 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 GitHubopen in new window 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.