FCLI Foundational Components CLI

Helps spread the AwesomeSauce of the Foundational Components team a bit further.

Prerequisites

Python 3 is required. Python 2 is not supported.

Second, Python 3's bin directory needs to be in your PATH environment variable. For example, if you are using the python.org install on macOS, you will need to add the following to your ~/.profile.

PATH="/Library/Frameworks/Python.framework/Versions/3.*/bin:${PATH}"

Installation

fcli is located on PyPI.

To install, run the following.

$ pip3 install fcli

sudo may be needed if your Python 3 installation is in a protected directory. This will put the command the bin directory of your Python 3 installation.

To update fcli to the latest version, run the following.

$ pip3 install --upgrade fcli

Again, sudo may be required.

Specifying Credentials

fcli uses your EUA credentials to authenticate yourself to JIRA, etc. There are multiple ways to specify your credentials.

File

Create an ini file at ~/.fcli. In there, add the [default] section, and under that section specify a username and password. An example can be seen in fcli.ini. Additionally, if you need the reporting functionality, add a [gapps] section and under that section specify service-acct-creds and sheet-create-url. service-acct-creds is a full path to a credentials file to use with Google Apps and sheet-create-url is a URL used to create a document in Google Drive.

Environment Variables

The environment variables FCLI_USER and FCLI_PASS can be utilized to specify the username and password. The environment variables FCLI_G_SERV_ACCT_CREDS and FCLI_G_SHEET_CREATE_URL can be utilized to specify the Google credential file path and document creation URL.

CLI

Only the username can be specified via the CLI. Tack on the --username <username> option.

Keyboard

If the username or password is not specified in some other fashion, the CLI will prompt the user. Similarly, the Google credential file path and Google document creation URL will be prompted.

Usage

Story Administration

Story Creation

To create a story in the backlog use

$ fcli backlog create story '<story title>'

You will be prompted to enter a Description and Acceptance Criteria.

Task Administration

Task Creation

There are three types of tasks the fcli can add: triage, EL, and backlog tasks.

To add a triage task,

$ fcli triage create "<task title>" "<task description>"  [--importance <High/Medium/Low>] [--effort <High/Medium/Low>] [--due <date in the future>] [--in-progress] [--assign]

A new task is created in the triage board with the specified title and description. Optionally, put the task into the In Progress state with the --in-progress option, and optionally assign the task to yourself with --assign. The importance, effort, and due date are required, and they will be prompted for if they are not supplied on the command line.

To add an EL task,

$ fcli el create "<task title>" "<task description>"  [--importance <High/Medium/Low>] [--effort <High/Medium/Low>] [--due <date in the future>] [--in-progress] [--assign]

A new task is created in the EL board with the specified title and description. EL tasks require the same options as triage tasks.

To add a backlog task,

$ fcli backlog create task "<task title>" "<task description>" <parent story>

A new task is created in the standard backlog with the specified title and description. The task is linked with the parent story. If the parent story is already in an active sprint, the task is also moved into the same sprint.

Other Task Functions

To move a task from one status to another...

$ fcli task move <task key> <target status>

Valid task statuses are:

Open, Ready, In Progress, Blocked, Closed, Triage, Ready for Refinement, Needs Work, Refined, Socialize, Reopened, Resolved

If the status chosen is more than a single word, surround the status in quotes like:

$ fcli task move <task key> 'In Progress'

If you are moving a task to either Resolved or Closed status, you are required to enter a Resolution and an optional comment:

$ fcli task move <task key> Resolved --comment 'This is an optional comment'
Please enter a resolution (Fixed, Duplicate, Done, Won't Do):

Though there are other resolutions that can be chosen, these are the most common resolutions and the only ones accepted.

To run the triage and EL task scoring process...

$ fcli task score

You will see the list of issues that are being updated as well as notification as to whether a particular issue is being updated or not. The final output of this command will display the total number of tasks and how many were updated and not updated:

Tasks: 92, Task scoring results updated: {False: 39, True: 53}

To add yourself to the watchlist for one or more tasks to receive notifications...

$ fcli task watch PROJECTA-1 PROJECTB-2

Other Backlog Functions

To add a calculated VFR value to a story in the backlog and move it to Refined status...

$ fcli backlog score <task key> <duration> <cost of delay>

Triage Task Administration

There are currently two different tasks for triage administration: search for all open triage tasks and update the score for all open triage tasks.

To search for all open triage tasks,

$ fcli triage search

A json representation of all of the open triage tasks will be printed to the terminal.

The scores of all open triage tasks will be updated. The terminal will show progress.

Reports

The reporting functionality is currently not very generalized and the backing JQL queries are fairly specific to the FC team.

VFR Sanity Check

The VFR Sanity Check report can be generated using

$ fcli reports vfrsanity

This report will create a Google sheet with two tabs. The first will order and group all stories by Duration value and the second will order and group all stories by Cost of Delay value.

User Tasks

The User Tasks report can be generated using

$ fcli reports usertasks

This report will generate a Google sheet with one tab of names of everyone on the project and then one tab each for the tasks for each person.

Development

I accept PRs! Check out the issues and assign yourself when you start working on one.