MCPcopy Create free account
hub / github.com/remotemobprogramming/mob / Help

Function Help

help/help.go:8–71  ·  view source on GitHub ↗
(configuration config.Configuration)

Source from the content-addressed store, hash-verified

6)
7
8func Help(configuration config.Configuration) {
9 output := configuration.CliName + ` enables a smooth Git handover
10
11Basic Commands:
12 start Start session from base branch in wip branch
13 next Handover changes in wip branch to next person
14 done Squash all changes in wip branch to index in base branch
15 reset Remove local and remote wip branch
16 clean Removes all orphan wip branches
17
18Basic Commands with Options:
19 start [<minutes>] Start <minutes> minutes timer
20 [--include-uncommitted-changes|-i] Move uncommitted changes to wip branch
21 [--discard-uncommitted-changes|-d] Discard uncommitted changes
22 [--branch|-b <branch-postfix>] Set wip branch to 'mob/<base-branch>` + configuration.WipBranchQualifierSeparator + `<branch-postfix>'
23 [--create|-c] Create the remote branch
24 [--join|-j] Join existing wip branch
25 [--room <room-name>] Set room name for timer.mob.sh once
26 next
27 [--stay|-s] Stay on wip branch (default)
28 [--return-to-base-branch|-r] Return to base branch
29 [--message|-m <commit-message>] Override commit message
30 done
31 [--no-squash] Squash no commits from wip branch, only merge wip branch
32 [--squash] Squash all commits from wip branch
33 [--squash-wip] Squash wip commits from wip branch, maintaining manual commits
34 reset
35 [--branch|-b <branch-postfix>] Set wip branch to 'mob/<base-branch>` + configuration.WipBranchQualifierSeparator + `<branch-postfix>'
36
37Timer Commands:
38 timer <minutes> Start a <minutes> timer
39 [--room <room-name>] Set room name for timer.mob.sh once
40 timer open Opens the timer website
41 [--room <room-name>] Set room name for timer.mob.sh once
42 start <minutes> Start mob session in wip branch and a <minutes> timer
43 break <minutes> Start a <minutes> break timer
44 goal Gives you the current goal of your timer.mob.sh room
45 [<your-goal>] Sets the goal of your timer.mob.sh room
46 [--delete] Deletes the goal of your timer.mob.sh room
47
48Short Commands (Options and descriptions as above):
49 s Alias for 'start'
50 n Alias for 'next'
51 d Alias for 'done'
52 b Alias for 'branch'
53 t Alias for 'timer'
54 g Alias for 'goal'
55
56Get more information:
57 status Show status of the current session
58 fetch Fetch remote state
59 branch Show remote wip branches
60 config Show all configuration options
61 version Show tool version
62 help Show help
63
64Other
65 moo Moo!

Callers 1

executeFunction · 0.92

Calls 1

SayFunction · 0.92

Tested by

no test coverage detected