NAME

repomatic sync-gitignore - Sync .gitignore from gitignore.io templates

SYNOPSIS

repomatic sync-gitignore [OPTIONS]

DESCRIPTION

Sync a .gitignore file from gitignore.io templates.

Fetches templates for a base set of categories plus any extras from [tool.repomatic] config, then appends gitignore-extra-content. Writes to the path specified by gitignore-location (default ./.gitignore).

The generated file is the whole file: nothing is read back from the copy on disk. A rule added there by hand is therefore dropped on the next sync, so the write aborts when it would lose one. Move the rule into gitignore-extra-content to keep it, or pass --drop-orphans to let it go.

OPTIONS

--output FILE: Output path. Defaults to gitignore-location from [tool.repomatic] config.
--drop-orphans / --no-drop-orphans: Overwrite rules found on disk but absent from the generated file, instead of refusing to drop them.
--help / -h: Show this message and exit.

ENVIRONMENT

SYNC_GITIGNORE_OUTPUT_PATH: Output path. Defaults to gitignore-location from [tool.repomatic] config.
SYNC_GITIGNORE_DROP_ORPHANS: Overwrite rules found on disk but absent from the generated file, instead of refusing to drop them.
SYNC_GITIGNORE__CLICK_DEFAULT_HELP: Show this message and exit.

EXIT STATUS

0: Success.
1: A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).
2: A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

Generate .gitignore using config from pyproject.toml

repomatic sync\-gitignore

Write to custom location

repomatic sync\-gitignore \-\-output ./custom/.gitignore

Preview on stdout

repomatic sync\-gitignore \-\-output \-

AUTHORS

Kevin Deldycke