[Go to site: main page, start]

Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command Line Interface

git gamble --help
Blend TDD (Test Driven Development) + TCR (`test && commit || revert`) to make sure to develop
the right thing 😌, baby step by baby step 👶🦶

Usage: git-gamble [OPTIONS] <--pass|--fail> -- <TEST_COMMAND>...
       git-gamble [OPTIONS] <COMMAND>

Commands:
  generate-shell-completions  
  hook                        Help to use samples hooks
  help                        Print this message or the help of the given subcommand(s)

Arguments:
  <TEST_COMMAND>...  The command to execute to know the result [env: GAMBLE_TEST_COMMAND=]

Options:
  -g, --pass                               Gamble that tests should pass [aliases: --green, --refactor]
  -r, --fail                               Gamble that tests should fail [aliases: --red]
  -n, --dry-run                            Do not make any changes and run test command
      --no-verify                          Do not run git hooks
  -C, --repository-path <REPOSITORY_PATH>  Repository path [default: .]
  -m, --message <MESSAGE>                  Commit's message [default: ""]
  -e, --edit                               Open editor to edit commit's message
      --fixup <FIXUP>                      Fixes up commit
      --squash <SQUASH>                    Construct a commit message for use with `rebase --autosquash`
  -h, --help                               Print help
  -V, --version                            Print version

Any contributions (feedback, bug report, merge request ...) are welcome
https://git-gamble.is-cool.dev/contributing/index.html

Shell completions

To manually generate shell completions, use this command :

git gamble generate-shell-completions --help
Usage: git-gamble generate-shell-completions [SHELL]

Arguments:
  [SHELL]
          Put generated file here :
          * Bash : add it to your bash profile in ~/.bashrc
          * Fish : see https://fishshell.com/docs/current/completions.html#where-to-put-completions
          * Powershell : see https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles
          * Others shells : don't know, MR are welcome
          
          [possible values: bash, elvish, fish, powershell, zsh]

Options:
  -h, --help
          Print help (see a summary with '-h')

Hooks

To use examples hooks, use this command :

git gamble hook --help
Help to use samples hooks

Usage: git-gamble hook <COMMAND>

Commands:
  enable   Enable a sample hook
  disable  Disable a sample hook
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Require git 2.54.0 or higher to actually execute hooks

With git 2.53.0 or below, you have to manually setup hooks
https://git-gamble.is-cool.dev/usage/hooks/examples.html#using-with-git-2530-or-below

The available hooks are just examples
Create any others behaviors using hooks using the standard git hook API
https://git-scm.com/docs/git-hook

To have more informations, read the documentation about hooks
https://git-gamble.is-cool.dev/usage/hooks.html