Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.01 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.01 KB
Raw

Arrr! mob

Shiver me timbers! A command-line tool fer social codin', written in Rust

License: GPL v3 Arrr: Arrr

built with nix

Includes Co-authored by lines in commits for ye automatically when ye collaborate on code. Use when pairin' wit' a matey or mobbin' wit' yer crew.

Embark via Flakehub (recommended)

  1. Install from Flakehub
  2. Add co-pirates by running: 
    rmob copirate enlist cb "Charlotte de Berry" "[email protected]"
  3. In your repo, rmob embark
  4. rmob sail away!

Embark Manually

  1. git clone this ship
  2. Install rmob on your machine using one of the commands below:
    • Standard: cargo install --path .
    • Nix: nix-env -iA package -f .
  3. Add co-pirates by running: 
    rmob copirate enlist cb "Charlotte de Berry" "[email protected]"
  4. In your repo, rmob embark
  5. rmob sail away!
Rmob 1.0.0
Arr! Git mobbing in Rust

USAGE:
    rmob [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --git-copirates-file <git_copirates_file>     [env: GIT_COPIRATES_FILE=]  [default: .git-copirates]

SUBCOMMANDS:
    copirate              Edit copirates list
    embark                Embark on rmob fer this git repo, call this once t' use rmob in yer git repo
    help                  Prints this message or the help of the given subcommand(s)
    prepare-commit-msg    Called from the git hook only
    sail                  Start pairin' or mobbin' by passin' a list of yer co-pirates te sail wit'
    solo                  Sail solo (short fer `rmob sail solo`)

Looted from the scallywags o'er at 'https://github.com/findmypast-oss/git-mob.

Mighty indebted!