Contents

module Rallycat
  class Help
    def to_s
      <<-HELP
Rallycat is a command-line utility for interacting with Rally. It should be
used to support a command-line centric workflow. Rallycat has the simple goal
of being a lightweight alternative to Rally's web interface. It provides quick
access to Rally features that are important to developers in their day-to-day
work.

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. An additional project attribute can be added to make some
  commands easiser to use. Example:

    username: [e-mail]
    password: pass1234
    project:  SuperBad

  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]                           # Your Rally username
  -p [PASSWORD]                           # Your Rally password
  -h, --help                              # Displays this help text

Commands:
  rallycat cat <story number>             # Displays a user story or defect
  rallycat update <task number>           # Updates the state of a task
    [--blocked | -b] [--in-progress | -p]
    [--completed | -c] [--defined | -d]
    [--owner | -o <fullname>]
  rallycat list                           # List iterations and stories
    [--project | -p <project name>]
    [--iteration | -i <iteration name>]
  rallycat help                           # Displays this help text


      HELP
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rallycat-0.4.1	lib/rallycat/help.rb
rallycat-0.4.0	lib/rallycat/help.rb