Package: piknik
NAMEpiknik - Issue tracking using CLISYNOPSISpiknikadd [ -d store_dir ] [ --alias issue_alias ] captionpiknikshow [ -i issue_id ] [ -d store_dir ] [ -r renderer ]
[ --state state ]piknikshow [ -d store_dir ] -r html [ -o output_dir ]piknikmod < -i issue_id > [ -d store_dir ] [ --state state
] [ -t tag ] [ -u tag ] [ --dep issue_id ] [ --undep issue_id
] [ --assign id ] [ --unassign id ]piknikmod < -i issue_id > [ -d store_dir ] [ --block ]piknikmod < -i issue_id > [ -d store_dir ] [ --unblock ]piknikcomment < -i issue_id > [ -d store_dir ] [ [ -x "text
content" ... ] [ -y file ... ] ... ]DESCRIPTIONThis tool enables issue tracking by command line interface.After an issue has been created it can move through different
pre-defined, kanban-like states. They can also be tagged, assigned and
commented on.COMMANDSThe following commands are available:show- Output all issues for all or selected issue states.add- Propose a new issue.mod- Tag, assign, set dependencies and modify state of an
existing issue.comment- Add comment to an existing issue.Common options-d:   Issue state store directory.-h--helpCommand help summary.-iissue_id--issue-idissue_idIssue to operate on. Argument can be issue
alias or full issue uuid. Only available withmodandcomment.-sstate--statestateLimit output to issue having the givenstate.
(Only valid withshowormod).-v:   Write debugging log to standard error.Options for add--alias:   Specify alias used to refer to issue when using-i. If not
specified, an alias will be auto-generated. SeeALIAS. Only
available withadd.Options for show-f--filesSave attachments to filesystem. Can be used in the context
of viewing details of a single issue, or in conjunction with-r html
-o. Only available withshow.-odir--files-dirdirOutput issue details to individual files indir.
Only available withshow -r html ....-rformat--rendererformatOutput format. Valid values areplainandhtml.-reverse:   Sort comments with oldest first. Only available withshow.--show-finished:   Include issues with stateFINISHEDin output. Only available
withshow.Options for mod--assignkey_id:   Assign the issue to entity defined bykey_id. If it is the first
assignment for an issue, the assigned will become the issueowner(see--ownerandACTIONS/Assignmentbelow. Only available
withmod.--block:   Set theBLOCKEDstate on the issue. Preserves the previous
state; a following--unblockinstruction will return the issue
to the pre-blocked state. Only available withmod.--depissue_id:   Make the current issue (identified by-idependent onissue_id. Only available withmod.--ownerkey_id:   Set the entity represented bykey_idas issue owner.-ttag--tagtagAdd the given tag to the issue. Only available withmod.--unassignkey_id:   Remove the assignment of the issue to entity defined bykey_id.
Only available withmod.--unblock:   Remove block on issue. Will return the issue to its previous state
(before the block). Only available withmod.--undepissue_id:   Remove dependency onissue_id. Only available withmod.-utag--untagtagRemove the given tag from the issue. Only available
withmod.Options for comment-spgp_key_fingerprint--sign-aspgp_key_fingerprintUse the private key matching the
fingerprint to sign (instead of the default key). Only available withcomment.-xtext--texttextAdd a text content part to the comment. Must be
enclosed by double quotes. Only available withcomment.-yfile--filefileAdd file as content part to the comment. Can be any
type of file. Only available withcomment. See theCOMMENTsection for more information.STATESThe tracking of the issue lifetime is organized using a pre-defined set
of kanban-like states.PROPOSED:   The initial state of an issue after being created bypiknik add.
Is intended for review by issue board moderator.BACKLOG:   The initial state of an issue after being "accepted" by a
moderator.PENDING:   An issue has been queued for imminent processing.DOING:   An issue is currently being worked on.REVIEW:   Work that was done on an issue is currently in review.BLOCKED:   Progress on aPENDINGissue is currently not possible.FINISHED:   Processing of an issue has been completed.ACTIONSAssignmentIndicates an individual or entity that is responsible for processing the
issue.Currently assigments are defined as hexadecimal values. By convention,
the value should correspond to e.g. a public key or a key fingerprint
(e.g. PGP).piknikwill check that the value is hexadecimal, but
will not do additional verification.The first assigned entity to an issue automatically becomes the issue
owner. The issue ownership may be changed using--owner, but
ownership cannot be removed entirely after the initial assignment.TaggingAny issue may be assigned any number of tags. Tags may be added and
removed individually.DependenciesAny issue may be set as dependent on another issue. Dependencies may be
set or unset. Dependencies must be manually managed, and will not be
magically removed as a side-effect of state transitions.COMMENTINGComments are stored as email-like Multipart MIME message logs. They may
include any number of plaintext and file attachment parts intermingled.All comments must besignedusing a PGP key. Unless the-sflag
is used, the default signing key will be used. It is currently not
possible to comment without a PGP key.RENDERINGThere are currently two rendering options for displaying issue indices
and individual issue details,plain(plain text) andhtml.
Ideosyncracies for each are described below.PLAINWhen listing the issue index, output will be in the form:[STATE]
<caption>	<tags>	<uuid>	[(alias)]Per-issue render should be self-explanatory.HTMLIf rendered with-ooutdirit creates a browseable version of
individual issues from the issue index in the specified directory.Some image types will by default be displayed inline. There is currently
no way to toggle this behavior.EXAMPLEThis example illustrates a possible lifetime of an issue.# propose new issue
piknik add Title describing the issue --alias myissue

# accept proposed issue (move to backlog state)
piknik mod -i myissue --accept

# move the issue to state "DOING"
piknik mod -i myissue --state doing

# tag the issue as a "BUG"
piknik mod -i myissue --tag bug

# Add a signed text comment to the issue
piknik comment -i myissue -x "This is a text comment"

# Add a comment with intermixed text and attachment contents to the issue
piknik comment -i myissue -x "This is a text comment with two attachments " -y attachment.png -y another.pdf -x "This text follows the attachments"

# Write index of all issues as plain text to standard output
piknik show

# Write issue details as plain text to standard output
piknik show -i myissue

# Write index of all issues as html to standard output
piknik show --render html

# Write index and individual issue as browseable html to directory "outdir"
piknik show --render html -o outdir

# Mark issue as finished
piknik mod -i myissue --finishKNOWN ISSUESCurrently issues are tracked using - in fact -piknik. An HTML
(read-only) render can be found athttps://holbrook.no/issues/piknikLICENSEThis documentation and its source is licensed under the Creative Commons
Attribution-Sharealike 4.0 International license.The source code of the tool this documentation describes is licensed
under the GNU General Public License 3.0.COPYRIGHT AND CONTACTLouis Holbrookhttps://holbrook.noPGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001SOURCE CODEhttps://git.defalsify.org/piknikABOUT THIS DOCUMENTThis document was generated usingpandoc -f man -t markdown ...