solbero / ignoro

Create .gitignore files with ease from your command line!

Create .gitignore files with ease from your command line!

About

Ignoro is a command line interface designed to help you quickly create and modify .gitignore files for your projects. The CLI uses one or more of the 550+ templates supplied by gitignore.io to craft the perfect .gitignore for your project.

Features

• Search for templates at gitignore.io.
• Show the content of a template from gitignore.io.
• Create a .gitignore file based on one or more templates.
• List templates used in a .gitignore file.
• Add one or more templates to a .gitignore file.
• Remove one or more templates from a .gitignore file.

Installation

Using pipx (recommended)

pipx install ignoro

Using pip

pip install --user ignoro

Usage

ignoro

Create or modify a .gitignore file based on templates from gitignore.io.

ignoro [OPTIONS] COMMAND [ARGS]...

Options

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands

• add: Add templates to a .gitignore file.
• create: Create a .gitignore file.
• list: List templates in a .gitignore file.
• remove: Remove templates from a .gitignore file.
• search: Search for templates at gitignore.io.

ignoro add

Add templates to a .gitignore file. If no path is provided, the templates will be added to the .gitignore file in the current directory.

ignoro add [OPTIONS] TEMPLATES...

Arguments

• TEMPLATES: Templates to add to .gitignore file. [required]

Options

• --path: Add templates to .gitignore file at this path.
• --show-gitignore: Show the result of the add command instead of writing a file.
• --help: Show this message and exit.

ignoro create

Create a .gitignore file. If no path is provided, the .gitignore file will be created in the current directory.

ignoro create [OPTIONS] TEMPLATES...

Arguments

• TEMPLATES: Templates to include in .gitignore file. [required]

Options

• --path: Create a .gitignore file at this path.
• --show-gitignore: Show the result of the create command instead of writing a file.
• --help: Show this message and exit.

ignoro list

List templates in a .gitignore file. If no path is provided, the templates from the .gitignore file in the current directory will be listed.

ignoro list [OPTIONS]

Options

• --path: List templates in .gitignore file at this path.
• --help: Show this message and exit.

ignoro remove

Remove templates from a .gitignore file. If no path is provided, the templates will be removed from the .gitignore file in the current directory.

ignoro remove [OPTIONS] TEMPLATES...

Arguments

• TEMPLATES: Templates to remove from .gitignore file. [required]

Options

• --path: Remove templates from .gitignore file at this path.

• --show-gitignore: Show the result of the remove command instead of writing a file.

• --help: Show this message and exit.’

ignoro search

Search for templates at gitignore.io. If no search term is provided, all available templates will be listed.

ignoro search [OPTIONS] [TERM]

Arguments

• TERM: Term used to search gitignore.io.

Options

• --help: Show this message and exit.’

ignoro show

Show a template from gitignore.io. If no no match is found, an error will be raised.

ignoro show [OPTIONS] TEMPLATE

Arguments

• TEMPLATE: Template to show from gitignore.io. [required]

Options

• --help: Show this message and exit.

Development

Setup

Ignoro uses PDM to manage dependencies and virtual environments. To get started, first install PDM. Then, install the project dependencies using the command:

pdm install

Run

To run the CLI, use the command:

pdm run ignoro

Test

Ignoro uses pytest for testing. To run the test suite, use the following command:

pdm run pytest .

Formating and Linting

Ignoro uses Ruff for formatting and linting. To run the formating and linting checks, use the following command:

pdm run ruff format .
pdm run ruff check .

License

Ignoro is licensed under the MIT License.