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
# File 'lib/rallycat/help.rb', line 3

def to_s
  <<-HELP
Rallycat is a command line utility for interacting with Rally.

Configuration:
  Configuration is available through a ~/.rallycatrc file formatted as YAML.
  The file should have two keys: `username` and `password` for authenticating
  with the Rally API.

  Additionally, the `-u [USERNAME]` and `-p [PASSWORD]` flags may be provided
  at runtime and will take higher precedence than the configuration file.

Global Options:
  -u [USERNAME]                           # The Rally user
  -p [PASSWORD]                           # The password for the Rally user
  -h, --help                              # Displays this help text

Commands:
  rallycat cat <story number>             # Displays the user story or defect
  rallycat update <task number>           # Displays the user story
[--blocked | -b] [--in-progress | -i]
[--completed | -c] [--defined | -d]
[--owner | -o <fullname>]
  rallycat help                           # Displays this help text


  HELP
end