Create useful .gitignore files for your project
Install 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
#!/bin/bash
$ git config --global alias.ignore '!gi() {
curl -L -s https://www.gitignore.io/api/$@ ;
}
; gi'Linux
#!/bin/bash
$ echo "function gi() {
curl -L -s https://www.gitignore.io/api/\$@ ;
}
" >> ~/.bashrc && source ~/.bashrc#!/bin/zsh
$ echo "function gi() {
curl -L -s https://www.gitignore.io/api/\$@ ;
}
" >> ~/.zshrc && source ~/.zshrc#!/bin/fish
$ printf "function gi\n\tcurl -L -s https://www.gitignore.io/api/\$argv\nend\n" > ~/.config/fish/functions/gi.fishmacOS
#!/bin/bash
$ echo "function gi() {
curl -L -s https://www.gitignore.io/api/\$@ ;
}
" >> ~/.bash_profile && source ~/.bash_profile#!/bin/zsh
$ echo "function gi() {
curl -L -s https://www.gitignore.io/api/\$@ ;
}
" >> ~/.zshrc && source ~/.zshrc#!/bin/fish
$ printf "function gi\n\tcurl -L -s https://www.gitignore.io/api/\$argv\nend\n" > ~/.config/fish/functions/gi.fishWindows
Create a 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.gitignore.io/api/$params" | select -ExpandProperty content | Out-File -FilePath $(Join-Path -path $pwd -ChildPath ".gitignore") -Encoding ascii
}
Create a 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.gitignore.io/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 @set PATH=%git_install_root%\bin;%git_install_root%\mingw\bin;%PATH% @if not exist "%HOME%" @set HOME=%HOMEDRIVE%%HOMEPATH% @if not exist "%HOME%" @set HOME=%USERPROFILE% @curl.exe -L -s https://www.gitignore.io/api/%*Other Clients
Clients maintained by third-party developers
| Source Code | Language | Instructions | Maintainer |
|---|---|---|---|
| gogi | Go | Install | Cuong Manh Le |
| ignr | Python | Usage | Antriksh Yadav |
Tools or extensions maintained by third-party developers on other platforms
| Source Code | Platform | Instructions | Maintainer |
|---|---|---|---|
| fzf-gitignore | Neovim | Install | Filip Szyma?ski |
| gi | Visual Studio Code | Install | Hasit Mistry |
| helm-gitignore | GNU Emacs | Install | Juan Placencia |
Use Command Line
After the function is created, the gi command will give you command line access to the gitignore.io API. . Note: Use gig if you are on Windows
Preview
Show output on the command line. Note: Use gig if you are on Windows
$ gi linux,java # Created by https://www.gitignore.io ### Linux ### .* !.gitignore *~ ### Java ### *.class # Package Files # *.jar *.war *.earGlobal
Append Operating System and IDE settings to global .gitignore. Note: Use gig if you are on Windows
$ gi linux,eclipse >> ~/.gitignore_globalProject
Appending Programming Langauge settings to your projects .gitignore. Note: Use gig if you are on Windows
$ gi java,python >> .gitignoreList
List displays a list of all of the currently support gitignore.io templates. Note: Use gig if you are on Windows
$ gi list actionscript,ada,agda,android,appceleratortitanium,appcode,archives, archlinuxpackages,autotools,bancha,basercms,bower,bricxcc,c,c++,cakephp, cfwheels,chefcookbook,clojure,cloud9,cmake,codeigniter,codekit,commonlisp, compass,composer,concrete5,coq,cvs,dart,darteditor,delphi,django,dotsettings, dreamweaver,drupal,eagle,eclipse,elasticbeanstalk,elisp,elixir,emacs,ensime, episerver,erlang,espresso,expressionengine,fancy,finale,flexbuilder,forcedotcom, freepascal,fuelphp,gcov,go,gradle,grails,gwt,haskell,intellij,java,jboss,jekyll, jetbrains,joe,joomla,justcode,jython,kate,kdevelop4,kohana,komodoedit,laravel, latex,lazarus,leiningen,lemonstand,lilypond,linux,lithium,magento,matlab,maven, mercurial,meteor,modelsim,monodevelop,nanoc,netbeans,node,notepadpp,objective-c, ocaml,opa,opencart,openfoam,oracleforms,osx,perl,ph7cms,phpstorm,playframework, plone,prestashop,processing,pycharm,python,qooxdoo,qt,quartus2,r,rails,redcar, rhodesrhomobile,ros,ruby,rubymine,rubymotion,sass,sbt,scala,scrivener,sdcc, seamgen,senchatouch,silverstripe,sketchup,stella,sublimetext,sugarcrm,svn, symfony,symfony2,symphonycms,tags,target3001,tarmainstallmate,tasm,tex,textmate, textpattern,turbogears2,typo3,unity,vagrant,vim,virtualenv,visualstudio,vvvv, waf,wakanda,webmethods,webstorm,windows,wordpress,xamarinstudio,xcode,xilinxise, yeoman,yii,zendframeworkAdvanced Command Line Improvements
Advanced command line suggestions are tracked on the gitignore.io wiki.
Design
| Asset | Description |
|---|---|
| gitignore.io horizontal logo | |
| gitignore.io square logo |
Install Locally
Requirements
Instructions
$ git clone --recursive [email protected]:joeblau/gitignore.io.git $ cd gitignore.io/ $ vapor build $ vapor runCompanies
Here are some companies that use gitignore.io:
About
.gitignore.io is a web service designed to help you create .gitignore files for your Git repositories. The site has a graphical and command line method of creating a .gitignore for your operating system, programming language, or IDE.