Class: Rallycat::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/rallycat/help.rb

Instance Method Summary collapse

Instance Method Details

#to_sObject



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/rallycat/help.rb', line 3

def to_s
  "Rallycat is a command-line utility for interacting with Rally. It should be\nused to support a command-line centric workflow. Rallycat has the simple goal\nof being a lightweight alternative to Rally's web interface. It provides quick\naccess to Rally features that are important to developers in their day-to-day\nwork.\n\nConfiguration:\n  Configuration is available through a ~/.rallycatrc file formatted as YAML.\n  The file should have two keys: `username` and `password` for authenticating\n  with the Rally API. An additional project attribute can be added to make some\n  commands easiser to use. Example:\n\nusername: [email protected]\npassword: pass1234\nproject:  SuperBad\n\n  Additionally, the `-u [USERNAME]` and `-p [PASSWORD]` flags may be provided\n  at runtime and will take higher precedence than the configuration file.\n\nGlobal Options:\n  -u [USERNAME]                           # Your Rally username\n  -p [PASSWORD]                           # Your Rally password\n  -h, --help                              # Displays this help text\n\nCommands:\n  rallycat cat <story number>             # Displays a user story or defect\n  rallycat update <task number>           # Updates the state of a task\n[--blocked | -b] [--in-progress | -p]\n[--completed | -c] [--defined | -d]\n[--owner | -o <fullname>]\n  rallycat list                           # List iterations and stories\n[--project | -p <project name>]\n[--iteration | -i <iteration name>]\n  rallycat help                           # Displays this help text\n\n\n  HELP\nend\n"