How to use the command 'gibo' (with examples)

The gibo command is a tool for fetching gitignore boilerplates. It allows you to easily generate gitignore templates for different programming languages or project types. This article will provide examples of the various use cases of the gibo command.

Use case 1: List available boilerplates

Code:

gibo list

Motivation: Using the gibo list command allows you to see a list of available gitignore boilerplate templates. This is useful when you want to quickly find the appropriate template for a specific programming language or project.

Explanation: The gibo list command displays a list of available gitignore boilerplate templates. It does not require any arguments.

Example output:

Actionscript
Ada
Agda
...

Use case 2: Write a boilerplate to stdout

Code:

gibo dump python

Motivation: By using the gibo dump command followed by a specific boilerplate, you can print the contents of the template to the standard output (stdout). This is useful when you want to quickly view the contents of a specific gitignore template without writing it to a file.

Explanation: The gibo dump command followed by the name of a specific boilerplate (e.g., python) outputs the contents of the gitignore template for that specific language or project type.

Example output:

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

...

Use case 3: Write a boilerplate to .gitignore

Code:

gibo dump python >>.gitignore

Motivation: The gibo dump command followed by a specific boilerplate, when redirected to a file (e.g., .gitignore), allows you to append the contents of the template to that file. This is useful when you want to quickly add a gitignore template to your project.

Explanation: The gibo dump command, when followed by the name of a specific boilerplate, outputs the contents of the gitignore template for that specific language or project type. By redirecting the output using >>, you can append the template to a file.

Example output:

• Before running the command:

# Ignore compiled Python files
*.pyc
__pycache__/
 
# Ignore the virtual environment
venv/
 
# Ignore the IDE configuration files
.idea/
.vscode/

• After running the command:

# Ignore compiled Python files
*.pyc
__pycache__/
 
# Ignore the virtual environment
venv/
 
# Ignore the IDE configuration files
.idea/
.vscode/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

...

Use case 4: Search for boilerplates containing a given string

Code:

gibo search python

Motivation: The gibo search command allows you to search for boilerplate templates containing a specific string. This is useful when you want to find templates related to a specific programming language, framework, or other keywords.

Explanation: The gibo search command followed by a specific string searches for boilerplate templates that contain that string. It displays a list of the matching templates.

Example output:

Actionscript
Python
Python-Django
Python-Jinja
Python-Pygame
Python-Pyramid
Python-Sphinx
Python-VirtualEnv

Use case 5: Update available local boilerplates

Code:

gibo update

Motivation: The gibo update command allows you to update the available local boilerplates. This is useful when new boilerplates have been added or existing ones have been updated on the upstream repository, and you want to have the latest versions.

Explanation: The gibo update command updates the available local gitignore boilerplate templates by fetching the latest versions from the upstream repository.

Example output (assuming there is an update):

Updated available local boilerplates.

Conclusion:

The gibo command is a powerful tool for managing gitignore boilerplate templates. It allows you to easily list available templates, view or append specific templates, search for templates based on a given string, and update the available local templates. By utilizing these use cases, you can effectively manage your gitignore files and ensure that you are not committing unnecessary files to your Git repository.