workitem is a command line tool that puts work items where they belong, with your work!
You can call it with workitem
or wi
and you can log new issues as quickly as you can say, well, exactly what the issue is!
$ workitem add "debounce 'add again' button on main cart view" #bug ~1
And that's it. A new issue. With the tag #bug
and an estimated complexity of ~1
.
One line descriptions aren't enough? Run workitem new
for the editor:
To get started, run npm i -g workitem
, then in your git repo run workitem init
Example:
wi add "fix terrible bug"
You can optionally include as many #tags
as you wish and specify a ~complexity
in whatever estimation language you prefer e.g. story points ~10
or t-shirt sizes ~medium
or weight in carrots ~20kg
. workitem is unit of effort agnostic in the same way that your project manager is supposed to be.
If your work item is dependent on another item, you can specify that dependency with the <
and >
characters.
<
for example marks a work item as a child of, or smaller than, another. Adding a child item as follows, wi add "a task that can't be completed yet" <
f00b005
, would prevent task f00b005
being moved beyond the active stage of your newly created task in the work flow.
>
makes the item a parent of another and thus means the new item cannot be moved beyond the child work item it references. The parent-child relationships between items are many-to-many in most cases but they can be configured otherwise (see config to learn about good parenting)
Example:
wi move
id-or-index
[to] doing [-f]
Moving an item must be forced with -f
if you are moving from and to workflow stages that are neither specified as transitionable nor permitted by parent-child relationships (see config to learn about workflow transitions)
Example:
wi
Shows the current work item "board" truncated enough that it fits without much scrolling around.
Outputs:
Example:
wi show more
Shows all the work items that are in your current iteration, and if you don't work in iterations, all those that are not archived.
Outputs:
wi note
id-or-index
"interesting findings Alice!"
If you like .workitem and you would like the contributors to put your favoured features then you can