/ 
App-karr-0.600
/ App::karr::Cmd::Board

NAME

App::karr::Cmd::Board - Show board summary

VERSION

version 0.600

SYNOPSIS

karr board
karr board --tags
karr board --compact
karr board --json
karr board --done

DESCRIPTION

Renders a board-oriented summary grouped by status. The default output is a compact, Markdown-flavoured plaintext board: the board name as an # heading, each status as a ## section, and one - id | title | meta... line per task. This stays readable when piped, redirected, diffed, or pasted. Colour is added only when standard output is a terminal (and NO_COLOR is unset). Compact and JSON modes remain available for automation and scripting.

Archived tasks are not part of any of those renderings: they are left out of the columns, out of the cards, and out of every number in the footer, in all output modes. board reports the columns the board works in; App::karr::Cmd::List with --archived is where filed-away cards are read.

OUTPUT MODES

  • Default output

    Lists every board column as a ## Status section (in board order, empty sections included), except the board's final column, which is hidden unless --done is given. That column is done on a default board and whatever the board's last status is named on one imported from kanban-md. Each task renders as - id | title followed by priority (non-default only), @claimant, blocked:reason, and due:date tokens where applicable. A footer line totals tasks, claims, and blocks, and -- when the final column is hidden and non-empty -- appends a hint naming what it withheld, so the count is not silently lost: (2 done hidden) on a default board, (2 shipped hidden) where shipped is the final column.

  • --tags

    Adds an extra indented line of #tag tokens beneath each task that has tags.

  • --done

    Includes the board's final column, which is hidden by default, and suppresses the hidden-count footer hint. Applies to the default, --tags, and --json renderings; --compact always lists every column regardless.

  • --compact

    Prints one line per board column in the form status(count): ids.

  • --json

    Emits the board name, total task count, and a structured columns array with per-column task lists. The final column is always present with its real count, but carries an empty tasks list unless --done is given.

SEE ALSO

karr, App::karr, App::karr::Cmd::List, App::karr::Cmd::Show, App::karr::Cmd::Pick, App::karr::Cmd::Context

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/karr/issues.

IRC

Join #langertha on irc.perl.org or message Getty directly.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)