Answering if a local is in front of its remote.


Keywords
git, developer-tools
License
MIT
Install
pip install foran==2021.10.17

Documentation

foran

Answering if a local is in front of its remote.

The English "in front" may translate to the Danish "foran".

... and the default report stem foran-eller-bagved alludes to the English "In front or behind?" question which corresponds to the Danish "Foran eller bagved?"

Status

Experimental.

Note: The default branch is default.

Use

  • foran
    • foran diff
    • foran label
    • foran template
    • foran version

foran

In front or behind (Foran eller bagved)?

Identify and diff a local repository against the remote using templates for reports.

Usage:

$ foran [OPTIONS] COMMAND [ARGS]...

Options:

  • -V, --version: Display the foran version and exit [default: False]
  • -h, --help: Show this message and exit.

Commands:

  • diff: Diff the local against the remote repository...
  • label: Labels the local repository state
  • template: Output an example jinja template representing...
  • version: Display the foran version and exit

foran diff

Diff the local against the remote repository state

Usage:

$ foran diff [OPTIONS] [SOURCE]

Arguments:

  • [SOURCE]: [default: .]

Options:

  • -i, --input TEXT: [default: ]
  • -o, --output TEXT: [default: ]
  • -t, --template TEXT: [default: ]
  • -h, --help: Show this message and exit.

foran label

Labels the local repository state

Usage:

$ foran label [OPTIONS] [SOURCE]

Arguments:

  • [SOURCE]: [default: .]

Options:

  • -i, --input TEXT: [default: ]
  • -o, --output TEXT: [default: ]
  • -t, --template TEXT: [default: ]
  • -h, --help: Show this message and exit.

foran template

Output an example jinja template representing the defaults

Usage:

$ foran template [OPTIONS]

Options:

  • -o, --output TEXT: [default: ]
  • -h, --help: Show this message and exit.

foran version

Display the foran version and exit

Usage:

$ foran version [OPTIONS]

Options:

  • -h, --help: Show this message and exit.