Command Line

gitignore.io Templates Source Design

Search…

gitignore.io

Install

Use

Advanced Command Line

API

Design

Logo

Command Line

To run gitignore.io from your command line you need an active internet connection and an environment function. You need to add a function to your environment that lets you access the gitignore.io API.

Git
Bash
git config --global alias.ignore \
'!gi() { curl -sL https://www.toptal.com/developers/gitignore/api/[email protected] ;}; gi'
Linux
Bash
echo "function gi() { curl -sL https://www.toptal.com/developers/gitignore/api/\[email protected] ;}" >> \
~/.bashrc && source ~/.bashrc
Zsh
echo "function gi() { curl -sLw "\n" https://www.toptal.com/developers/gitignore/api/\[email protected] ;}" >> \
~/.zshrc && source ~/.zshrc
Fish
printf "function gi\n\tcurl -sL https://www.toptal.com/developers/gitignore/api/\$argv\nend\n" > \
~/.config/fish/functions/gi.fish
macOS
Bash
echo "function gi() { curl -sL https://www.toptal.com/developers/gitignore/api/\[email protected] ;}" >> \
~/.bash_profile && source ~/.bash_profile
Zsh
echo "function gi() { curl -sLw "\n" https://www.toptal.com/developers/gitignore/api/\[email protected] ;}" >> \
~/.zshrc && source ~/.zshrc
Fish
printf "function gi\n\tcurl -sL https://www.toptal.com/developers/gitignore/api/\$argv\nend\n" > \
~/.config/fish/functions/gi.fish
Windows
Paste the following scripts inside your PowerShell profile (run $profile inside PowerShell to get the profile's location path).
PowerShell v3 Script
#For PowerShell v3
Function gig {
  param(
    [Parameter(Mandatory=$true)]
    [string[]]$list
  )
  $params = ($list | ForEach-Object { [uri]::EscapeDataString($_) }) -join ","
  Invoke-WebRequest -Uri "https://www.toptal.com/developers/gitignore/api/$params" | select -ExpandProperty content | Out-File -FilePath $(Join-Path -path $pwd -ChildPath ".gitignore") -Encoding ascii
}
PowerShell v2 Script
#For PowerShell v2
Function gig {
  param(
    [Parameter(Mandatory=$true)]
    [string[]]$list
  )
  $params = ($list | ForEach-Object { [uri]::EscapeDataString($_) }) -join ","
  $wc = New-Object System.Net.WebClient
  $wc.Headers["User-Agent"] = "PowerShell/" + $PSVersionTable["PSVersion"].ToString()
  $wc.DownloadFile("https://www.toptal.com/developers/gitignore/api/$params", "$PWD\.gitignore")
}
Create a Command Line Prompt Script If you have installed msysgit), create gi.cmd with content below. And copy it to C:\Program Files\Git\cmd\gi.cmd, assuming msysgit was installed to c:\Program Files\Git. Make sure that C:\Program Files\Git\cmd is added to the environment variable path.
@rem Do not use "echo off" to not affect any child calls.
@setlocal
​
@rem Get the abolute path to the parent directory, which is assumed to be the
@rem Git installation root.
@for /F "delims=" %%I in ("%~dp0..") do @set git_install_root=%%~fI
@for /F "delims=" %%I in ("%~dp0..") do @set git_mingw_root=%%~fI\mingw
@if not exist "%git_mingw_root%" @set git_mingw_root=%git_install_root%\mingw64
@set PATH=%git_install_root%\bin;%git_mingw_root%\bin;%PATH%
​
@if not exist "%HOME%" @set HOME=%HOMEDRIVE%%HOMEPATH%
@if not exist "%HOME%" @set HOME=%USERPROFILE%
​
@curl.exe -L -s https://www.toptal.com/developers/gitignore/api/%*

gitignore.io

Next - Install

Editor Extensions

Last modified 1yr ago

Copy link

Outline

Git

Linux

macOS

Windows