/ 
App-karr-0.500
/ App::karr::Cmd::List

NAME

App::karr::Cmd::List - List tasks with filtering and sorting

VERSION

version 0.500

SYNOPSIS

karr list
karr list --status todo,in-progress --priority high,critical
karr list --claimed-by agent-fox --compact
karr list -s docker --json

DESCRIPTION

Lists tasks from the current board with optional filtering and sorting. Finished tasks are excluded by default so the output focuses on active work: that means the board's terminal statuses -- its final configured status plus archived, so done and archived on a default board, but shipped and archived on a board whose columns end in shipped. Ask for them by name with --status, or for the archive alone with --archived. Use --compact for terse one-line output and --json for machine-readable automation.

--json emits each task as the full payload "to_json_hash" in App::karr::Task builds -- the frontmatter fields plus the body when the task has one, the same shape karr show --json returns. Reading a set of tickets is therefore one call rather than one show per id; --compact is the flag for when the bodies are not wanted.

Note that karr excludes the whole terminal group here where kanban-md's list excludes only archived and still shows finished work. That is a deliberate difference, not an oversight: karr list is the agent's "what is open" view.

FILTERS AND SORTING

  • --status, --priority

    Accept comma-separated lists and only return tasks matching one of the requested values.

  • --archived

    Shows the archive and nothing else. It is a status filter, so it replaces --status rather than intersecting with it -- matching kanban-md's flag of the same name -- while the remaining filters still narrow the result.

  • --assignee, --tag, --claimed-by

    Limit the result set to a specific assignee, tag, or claim owner.

  • -s, --search

    Performs a case-insensitive substring search across title, body, and tags.

  • --sort, --reverse

    Sort by id, status, priority, created, updated, or due, and optionally reverse the result order. Any other field is a usage error (exit 2).

    status follows the board config's own order. priority deliberately reads the config list the other way, most urgent first: --sort priority lists critical before low with the default priorities setting, so the top of a priority-sorted list is the task App::karr::Cmd::Pick would hand out, and --reverse gives the least-urgent-first view. kanban-md's ascending config order opened the list with the least urgent task when karr took this direction; it has since made the same change, so the two agree. Tasks without a due date sort last. Ties are broken by id.

SEE ALSO

karr, App::karr, App::karr::Cmd::Show, App::karr::Cmd::Board, App::karr::Cmd::Create, App::karr::Cmd::Pick

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; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.