-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
This guide will help you install git-forest and get it running on your system.
- .NET 10 SDK or Runtime - Required to run git-forest
- Git - Version 2.x or higher
- Operating System - Windows, macOS, or Linux
The easiest way to install git-forest is as a .NET global tool:
dotnet tool install --global git-forestVerify the installation:
git-forest --versionTo install the latest pre-release version:
dotnet tool install --global git-forest --prereleaseIf you already have git-forest installed and want to update to the latest version:
dotnet tool update --global git-forestFor developers who want to contribute or run the latest development version:
1. Clone the repository:
git clone https://github.com/tweakch/git-forest.git
cd git-forest2. Build the solution:
dotnet restore
dotnet build --configuration Release3. Install as a local tool:
dotnet tool install --global --add-source ./src/GitForest.Cli/bin/Release git-forestOr run directly:
dotnet run --project src/GitForest.Cli -- --versionSee Building from Source for detailed development setup instructions.
git-forest can be invoked with the full command git-forest or a shorter alias gf.
For current session:
Set-Alias gf git-forestTo persist across sessions, add to your PowerShell profile:
notepad $PROFILEAdd this line:
Set-Alias gf git-forestFor current session:
alias gf='git-forest'To persist, add to your shell profile (~/.bashrc, ~/.zshrc, or ~/.bash_profile):
echo "alias gf='git-forest'" >> ~/.bashrc
source ~/.bashrcCreate a batch file named gf.bat in a directory on your PATH:
@echo off
git-forest %*After installation, verify that git-forest is working correctly:
# Check version
git-forest --version
# Display help
git-forest --help
# If you set up the alias
gf --versionOnce installed, navigate to a git repository and initialize your first forest:
cd /path/to/your/git/repo
git-forest init
git-forest statusSee the Quick Start Guide for your next steps.
If you get a "command not found" error after installation:
1. Check if .NET tools are in your PATH:
echo $PATH # Linux/macOS
echo %PATH% # Windows2. Add .NET tools directory to PATH:
-
Linux/macOS:
~/.dotnet/tools -
Windows:
%USERPROFILE%\.dotnet\tools
Linux/macOS:
export PATH="$PATH:$HOME/.dotnet/tools"Windows PowerShell:
$env:PATH += ";$env:USERPROFILE\.dotnet\tools"3. Restart your terminal after modifying PATH.
If you don't have .NET 10 installed:
Download and install from:
- Official site: https://dotnet.microsoft.com/download/dotnet/10.0
- Or use your package manager:
macOS (Homebrew):
brew install --cask dotnet-sdkUbuntu/Debian:
wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y dotnet-sdk-10.0If you encounter permission errors:
sudo chmod +x ~/.dotnet/tools/git-forestIf a previous version conflicts:
# Uninstall old version
dotnet tool uninstall --global git-forest
# Reinstall
dotnet tool install --global git-forestTo update to the latest stable release:
dotnet tool update --global git-forestTo update to a pre-release:
dotnet tool update --global git-forest --prereleaseTo remove git-forest from your system:
dotnet tool uninstall --global git-forestThis removes the tool but does not delete any .git-forest/ directories in your repositories.
? Installed git-forest successfully?
Continue to:
- Quick Start Guide - Create your first forest
- Core Concepts - Understand how git-forest works
- Working with Plans - Install your first plan
git-forest includes an optional Blazor web interface for visual management:
cd src/GitForest.Web
dotnet runThen open http://localhost:5000 in your browser.
See Web UI Guide for more details.
Having trouble installing? Check: