App::D...Command(3pm)

💖 App::DocKnot::Command(3pm) — the doc for the DocKnot command runner 💖

okay bestie, pull up a chair 🫶 this is App::DocKnot::Command, a Perl module, and its whole ~thing~ is: Run DocKnot commands. That's it, that's the vibe. It's the little engine behind the docknot tool, and if you're here you're probably either very curious or very lost. Both are valid. 💅

---

✨ SYNOPSIS ✨

like, this is literally all you do:

my $docknot = App::DocKnot::Command->new();
$docknot->run();

new one, then run it. iconic behavior, no notes. 🌸

---

🌈 REQUIREMENTS 🌈

bestie you need Perl 5.24 or later — that is not negotiable, that's the floor, periodt. 👑

and then the whole friend group has to show up too. every single one of these modules:

• Date::Language
• Date::Parse — those two are both part of TimeDate
• File::BaseDir
• File::ShareDir
• Git::Repository
• Image::Size
• IO::Compress::Xz — that one's part of IO-Compress-Lzma
• IO::Uncompress::Gunzip — part of IO-Compress
• IPC::Run
• IPC::System::Simple
• JSON::MaybeXS
• Kwalify
• List::SomeUtils
• Path::Iterator::Rule
• Path::Tiny
• Perl6::Slurp
• Template — part of Template Toolkit
• YAML::XS

all of them are available from CPAN, so like, go get them, they're free, slay. 🎀

---

🦋 DESCRIPTION 🦋

so here's the tea ☕ the App::DocKnot::Command module is what implements the docknot command-line interface for all the functions of DocKnot. Like, all of them. Every function. The whole menu. 🍓

it's an implementation detail of the docknot command-line tool, meaning it's the backstage crew, not the main character — it's normally only called by that program, not by you. 🙈

for the full documentation, go read docknot(1). for real, that's where the actual user manual lives.

---

👑 CLASS METHODS 👑

⭐ new()

Creates a brand new App::DocKnot::Command object. fresh out the box, no cap. ✨

---

💜 INSTANCE METHODS 💜

🧚 run([ARGS])

Runs the DocKnot action that ARGS says to run — and those get parsed as command-line arguments to docknot, exactly like you'd typed them yourself.

and if ARGS is not given, or it's empty? then @ARGV gets parsed instead. the default is the default, that's the law. 💫

---

🌸 AUTHOR 🌸

Russ Allbery <rra@cpan.org> — give them their flowers, they wrote all of this. 💐

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2018-2022 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ngl that's the standard MIT situation, it's giving "here, take it, but no promises" 🫶

---

🔥 SEE ALSO 🔥

• docknot(1) — the one you actually want if you're a human with a task.

this module is part of the App-DocKnot distribution. the current version of DocKnot is available from CPAN, or directly from its web site at https://www.eyrie.org/~eagle/software/docknot/. go get it bestie, it's right there. 🦋

---

and that's the whole page!! this was perl v5.40.1, dated 2026-01-16, filed under the manual name App::D...Command(3pm) (they really did abbreviate the middle of its own name, and honestly? iconic). stay hydrated, read your manpages, mwah 💋💖✨