AgileCli.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Edit-AgileCliConfiguration</command:name> <command:verb>Edit</command:verb> <command:noun>AgileCliConfiguration</command:noun> <maml:description> <maml:para>Opens the AgileCli configuration file for editing in your default yaml file editor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The AgileCli application currently has three configuration settings. One - `JiraHostName` - is required and must be set before you can use the tool. The others are optional. Use this command to open the configuration file for editing using the default yaml file editor on your system. </maml:para> <maml:para>1. `JiraHostName`: The host name for your Jira cloud instance, for example `my-company.atlassian.net`. Do not include `https://`. This setting is required, so that AgileCli knows where to retrieve your data. 2. `DefaultBoardName`: The default Jira board name to use. This can always be overridden by using the `-BoardName` parameter on each cmdlet. The default is `null`, which means there is no default, and that you must specify the board name whenever you invoke an AgileCli cmdlet. 3. `SprintTargetPercent`: The permissible margin of error in terms of achieving your sprint point commitment. The default is `15`, meaning teams are "on track" if the number of points completed each sprint is within 15% of the commitment total. If you're a real stickler, set this to `1`. If you like to offer a wide latitude, use `100`. If you enter a value below `1` or above `100`, it will default to `15`. The value entered must be expressed as a integer. Do not include a `%` sign.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Edit-AgileCliConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Edit-AgileCliConfiguration</dev:code> <dev:remarks> <maml:para>Opens the configuration file in the default yaml file editor registered on your system. Make your changes, save the file, and close.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JiraBoards</command:name> <command:verb>Get</command:verb> <command:noun>JiraBoards</command:noun> <maml:description> <maml:para>Returns a list of every board available on your Jira instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>AgileCli generates statistics based on a board not a project. Projects can have more than one board.) Use this command to find the Jira board you want information about.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JiraBoards</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-JiraBoards</dev:code> <dev:remarks> <maml:para>Returns a list of all available boards on your Jira instance and caches the results for one hour.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-JiraBoards -NoCache</dev:code> <dev:remarks> <maml:para>Returns a list of all available boards on your Jira instance and caches the results for one hour. The `-NoCache` option invalidates the cache and forces an update from the Jira API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PercentOnTargetSprints</command:name> <command:verb>Get</command:verb> <command:noun>PercentOnTargetSprints</command:noun> <maml:description> <maml:para>Returns the proportion of sprints where the number of completed points out of the number committed was within the permissible margin of error.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>How often does your team meet their sprint commitments? This cmdlet evaluates the specified collection of sprints and determines what proportion of them were completed within a margin of error, in terms of the number points committed versus the actual number of points completed . </maml:para> <maml:para>Let's say over the last 10 sprints, your team committed to 100 points each. In 6 of those sprints, they completed between 85 and 107 points. But in 4 of those sprints only 60 points were completed. That means 6 out of the 10 sprints were "on target" because they were completed within the default margin of error. The other 4 sprints did not meeting this objective. If you ran `Get-PercentOnTargetSprints -SprintCount 10` for this team, the result would be `60%` because only 6 out of the 10 sprints were completed within the margin of error. </maml:para> <maml:para>Note that the default margin of error is 15%. This can be changed to any value between 1 and 100. See `Edit-AgileCliConfiguration` for more information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PercentOnTargetSprints</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PercentOnTargetSprints -BoardName "My Awesome Team"</dev:code> <dev:remarks> <maml:para>Evaluates the last 10 sprints for the "My Awesome Team" board and returns the percent that were completed within the specified margin of error.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PercentOnTargetSprints -BoardName "My Awesome Team" -NoCache</dev:code> <dev:remarks> <maml:para>Invalidates the cache - if any - and evaluates the last 10 sprints for the "My Awesome Team" board and returns the percent that were completed within the specified margin of error.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-PercentOnTargetSprints -SprintCount 7</dev:code> <dev:remarks> <maml:para>Evaluates the last 7 sprints for the default Jira board and returns the percent that were completed within the specified margin of error.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ProjectVelocity</command:name> <command:verb>Get</command:verb> <command:noun>ProjectVelocity</command:noun> <maml:description> <maml:para>Returns the average points committed, completed, rolled over, and unplanned for the specified collection of sprints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to determine your team's average velocity for the specified collection of sprints, along with the average number of points committed, rolled over, and unplanned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ProjectVelocity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ProjectVelocity # Example output: AverageCommitted AverageCompleted AverageRollover AverageUnplanned ---------------- ---------------- --------------- ---------------- 35 27 8 2</dev:code> <dev:remarks> <maml:para>Gets the project velocity and related information for the default Jira board over the last 10 sprints.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ProjectVelocity -SprintCount 3 -BoardName "Woot"</dev:code> <dev:remarks> <maml:para>Gets the project velocity and related information for the "Woot" Jira board over the last 3 sprints.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SprintHistory</command:name> <command:verb>Get</command:verb> <command:noun>SprintHistory</command:noun> <maml:description> <maml:para>Returns metrics for the specified collection of sprints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns metrics for a set of sprints, including:</maml:para> <maml:para>- Sprint name</maml:para> <maml:para>- Sprint start and end times</maml:para> <maml:para>- Number of points committed</maml:para> <maml:para>- Number of unplanned points</maml:para> <maml:para>- Number of rollover points</maml:para> <maml:para>- Percent of rollover points</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SprintHistory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BoardName</maml:name> <maml:Description> <maml:para>The name of the Jira board. Required if a default board name is not saved, or if you wish to override the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoCache</maml:name> <maml:Description> <maml:para>Invalidates the cache and forces the data to refresh.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SprintCount</maml:name> <maml:Description> <maml:para>The number of sprints to evaluate. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SprintHistory</dev:code> <dev:remarks> <maml:para>Returns metrics for the default Jira board over the past 10 sprints.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SprintHistory -NoCache -BoardName "Magic" -SprintCount 25</dev:code> <dev:remarks> <maml:para>Invalidates the cache and returns metrics for the "Magic" Jira board over the past 25 sprints.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-JiraToken</command:name> <command:verb>Save</command:verb> <command:noun>JiraToken</command:noun> <maml:description> <maml:para>Securely stores your Jira API access token.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to securely store your Jira API access token. Note that this must be done before you can use the AgileCli tool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-JiraToken</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Save-JiraToken</dev:code> <dev:remarks> <maml:para>Follow the prompts to store your Jira API access token. Note that you cannot use keyboard shortcuts to paste the key . Instead, right click to paste. (PowerShell limitation. Sorry!)</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |