Package: fcli
FCLI Foundational Components CLIHelps spread the AwesomeSauce of the Foundational Components team a bit further.PrerequisitesPython 3is required.  Python 2 is not supported.Second, Python 3'sbindirectory needs to be in yourPATHenvironment 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}"Installationfcliis located onPyPI.To install, run the following.$pip3installfclisudomay be needed if your Python 3 installation is in a protected directory.  This will put the command thebindirectory of your Python 3 installation.To updatefclito the latest version, run the following.$pip3install--upgradefcliAgain,sudomay be required.Specifying Credentialsfcliuses your EUA credentials to authenticate yourself to JIRA, etc.  There are multiple ways to specify your
credentials.FileCreate an ini file at~/.fcli.  In there, add the[default]section, and under that section specify ausernameandpassword.  An example can be seen infcli.ini.Environment VariablesThe environment variablesFCLI_USERandFCLI_PASScan be utilized to specify the username and password.CLIOnly theusernamecan be specified via the CLI.  Tack on the--username <username>option.KeyboardIf the username or password is not specified in some other fashion, the CLI will prompt the user.UsageStory AdministrationStory CreationTo create a story in the backlog use$fclibacklogcreatestory'<story title>'You will be prompted to enter a Description and Acceptance Criteria.Task AdministrationTask CreationThere are three types of tasks thefclican add: triage, EL, and backlog tasks.To add a triage task,$fclitriagecreate"<task title>""<task description>"[--importance<High/Medium/Low>][--effort<High/Medium/Low>][--due<dateinthefuture>][--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-progressoption, 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,$fclielcreate"<task title>""<task description>"[--importance<High/Medium/Low>][--effort<High/Medium/Low>][--due<dateinthefuture>][--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,$fclibacklogcreatetask"<task title>""<task description>"<parentstory>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 FunctionsTo move a task from one status to another...$fclitaskmove<taskkey><targetstatus>To run the triage and EL task scoring process...$fclitaskscoreOther Backlog FunctionsTo add a calculated VFR value to a story in the backlog and move it to Refined status...$fclibacklogscore<taskkey><duration><costofdelay>Triage Task AdministrationThere 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,$fclitriagesearchA 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.DevelopmentI accept PRs!  Check out theissuesand assign yourself when you start
working on one.