tkf / recrepo Goto Github PK

usage: recrepo [-h] [--ignore-dirty] [--ignore-untracked] [--output OUTPUT]
               [--pretty] [--version]
               pointer [pointer ...]

Record repository status after asserting it's clean.

This script records the status of one or more repositories in a JSON
file (``recrepo.json`` by default).  It also asserts that those
repositories are clean (unless ``--ignore-dirty`` option is given) and
exit with an error code if files that are not tracked by git or not
committed are found.

Examples
--------
::
    recrepo PATH/TO/GIT/REPOSITORY
    recrepo --output=- PATH/TO/GIT/REPOSITORY
    recrepo REPOSITORY_1 REPOSITORY_2

Installation
------------
::
    wget https://raw.githubusercontent.com/tkf/recrepo/master/recrepo.py -O recrepo
    chmod u+x recrepo

positional arguments:
  pointer             Path to a file or directory inside a project. Multiple
                      paths can be given.

optional arguments:
  -h, --help          show this help message and exit
  --ignore-dirty      Ignore repositories with uncommitted files. By default,
                      uncommitted (and untracked) files result in exit with
                      return code 113. (default: False)
  --ignore-untracked  Ignore repositories with untracked files. By default,
                      untracked and uncommitted files result in exit with
                      return code 113. (default: False)
  --output OUTPUT     Path to output JSON file. "-" means stdout. (default:
                      recrepo.json)
  --pretty            Pretty-print JSON output. (default: False)
  --version           show program's version number and exit