ralio

ralio

A usable command-line client for rally.

Installation

$ npm install -g ralio

ralio also uses elinks to format HTML content - install it using homebrew.

Configuration

Create a config file in ~/.raliorc.

{
  "username": "USERNAME",
  "password": "PASSWORD",
  "project": "BACKLOG PROJECT NAME",
  "team": "TEAM PROJECT NAME"
}

username and password should be self-explanatory. project and team should contain the names of the Rally projects that correspond to your project backlog and your team. Where I work, we run multiple teams from a common product backlog, hence the different options. If you don't work that way, put the same project name in both.

Unfortunately, Rally doesn't use OAuth (or any other kind of API keys), so ralio needs your password. I suggest you chmod 0600 ~/.raliorc to prevent your password going walkies. In future I'll be stashing credentials in the OS key store.

Usage

See the built-in help:

$ ralio --help

  Usage: ralio [options] [command]

  Commands:

      backlog [options] 
      Show the product backlog
      
      sprint [options] 
      Show the current team iteration
      
      show <story>
      Show tasks for an individual story
      
      open <story>
      Open a story in a web browser
      
      start <task>
      Set a task state to in-progress and assign it to you
      
      finish <task>
      Set a task state to completed and assign it to you
      
      abandon <task>
      Set a task state to defined and clear the owner
      
      block <task>
      Set a task state to blocked
      
      unblock <task>
      Set a task state to unblocked
      
      current 
      Show your current tasks and stories
      
      point <story> <points>
      Set the points for a story
      
      task [options] <option> <target>
      Allow you to create and delete story tasks.
      Available options <option> [create|delete].
      In case of <option> create, <target> is the story name.
      In case of <option> delete, <target> is the task itself.

    Options:

      -h, --help     output usage information
      -V, --version  output the version number

    Usage examples of the task command to create and delete story tasks:

      $ ralio task create US1234 -n "name of the task"
      $ ralio task delete TA54322

Contributing

Contributions very welcome! Please write tests for any new features - use mocha to run the test suite.

License

Simplified BSD license

Copyright (c) Olly Smith All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.