/ 
App-karr-0.500
/ App::karr::Cmd::Materialize

NAME

App::karr::Cmd::Materialize - Write the ref-backed board out as a tasks/ file view

VERSION

version 0.500

SYNOPSIS

karr materialize
karr materialize --dir path/to/repo
karr materialize --json
karr materialize --force

DESCRIPTION

Writes the canonical refs/karr/* board out to the repository root as a kanban-md compatible file view: a config.yml plus a tasks/ directory of Markdown cards. The view is disposable and gitignored -- regenerate it whenever you want to grep the board as files or hand it to kanban-md tooling. It is never the source of truth, and writing through it only takes effect via karr import.

The refs are read but never modified, so this command performs no remote sync. Stale cards from a previous materialization -- the tasks/ files named the way karr and kanban-md name them, NNN-slug.md -- are removed before the current tasks are written. Any other file in tasks/ is left alone.

tasks/ and config.yml at a repository root are ordinary names for a project to already use, so the command refuses to run at all when it would overwrite or delete something Git tracks, and names every such path. Nothing is written on that path. Pass --force once you are sure those files are yours to replace.

For the same reason the .gitignore entries for the view are only topped up when the project has nothing of its own at those paths -- the check karr init makes. Git applies no ignore rule to a file it already tracks, so an entry there would be inert and would claim a path the project owns.

OPTIONS

  • --force

    Materialize even though git-tracked files at the destination will be overwritten or deleted.

  • --json

    Print the materialized tasks as a JSON array instead of a human-readable summary.

SEE ALSO

karr, App::karr, App::karr::Cmd::Import, App::karr::BoardStore, App::karr::Task

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.