caca

caca

A CLI tool for CA

Table of Contents

• Installation
• Available commands
  • ca --help
  • ca task --help
  • ca api [api key]
  • ca open
  • ca open [formatted ID]
  • ca task list [formatted ID]
  • ca task update [formatted ID] [status] [actuals]
  • ca task new [formatted story/defect ID] [taskName] [state] [estimate] [actuals]
• License

Installation

npm install --global caca

Available commands

ca --help

Ouputs description for each command

Usage example

$ ca --help

  Usage: ca [options] [command]


  Commands:

    task          do something with tasks
    api [apiKey]  Sets the CA API key
    open [id]     Opens the specified defect or story
    help [cmd]    display help for [cmd]

  Options:

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

ca task --help

Ouputs description for each task-related command

Usage example

$ ca task --help

  Usage: ca-task [options] [command]


  Commands:

    list|ls [formattedId]                                     Prints the list of tasks of the story/defect
    new [artifactId] [taskName] [state] [estimate] [actuals]  Adds a new task to a story/defect
    new-merge [taskPrefix]                                    Adds a new merge task to a story/defect
    update [formattedId] [status] [actuals]                   Updates status and actuals of the task

  Options:

    -h, --help  output usage information

ca api [api key]

Sets the API key that will be used to communicate with Rally. Other commands won't work without an API key.

Usage example

$ ca api _023djief03fh34ASjfwe0f2jASojsasf0

ca open

Opens the current Rally story/defect in the browser. The story ID is taken from the current branch name.

Usage example

# when on branch john-US123
$ ca open
# opens story US123 in the browser

ca open [formatted ID]

Opens the specified Rally story/defect in the browser.

Usage example

$ ca open US53439
# opens the story US53439 in the browser

ca open DE92342
# opens the defect DE92342 in the browser

Tasks

ca task list [formatted ID]

Prints out list of tasks added to the specified Rally story/defect in the CLI

Usage example

$ ca task list US53439
┌─────────────┬─────────┬───────────┬─────────┬─────────────┐
│ FormattedID │ Name    │ State     │ Actuals │ Owner       │
├─────────────┼─────────┼───────────┼─────────┼─────────────┤
│ TA95062     │ Dev     │ Completed │ 2       │ John Doe    │
├─────────────┼─────────┼───────────┼─────────┼─────────────┤
│ TA95147     │ merge   │ Completed │ 0.1     │ John Doe    │
├─────────────┼─────────┼───────────┼─────────┼─────────────┤
│ TA95180     │ QA      │ Completed │ 6       │ Jane Doe    │
├─────────────┼─────────┼───────────┼─────────┼─────────────┤
│ TA95232     │ CR      │ Completed │ 0.1     │ Richard Roe │
└─────────────┴─────────┴───────────┴─────────┴─────────────┘

or

$ ca task ls US53439

ca task update [formatted ID] [status] [actuals]

Updates status and actuals of the task Possible [status] options:

• d - defined
• p - In-Progress
• c - Completed

Usage example

$ ca task update TA95062 c 2

ca task new [formatted story/defect ID] [taskName] [state] [estimate] [actuals]

Adds a new task to a story/defect and prints the list of tasks after new one was created

Usage example

$ ca task new US53439 "dev" c 20 4
┌─────────────┬─────────┬───────────┬─────────┬─────────────┐
│ FormattedID │ Name    │ State     │ Actuals │ Owner       │
├─────────────┼─────────┼───────────┼─────────┼─────────────┤
│ TA95062     │ dev     │ Completed │ 4       │ John Doe    │
└─────────────┴─────────┴───────────┴─────────┴─────────────┘

License

MIT © Zoltan Kochan