App::S...::help(3pm)

💖 App::S...::help(3pm) — the whole tea on Sqitch's "help" command 🫶

okay so bestie, real talk: if you're here looking for how to use the help command, you want sqitch-help, not this page. this is the under-the-hood, behind-the-scenes, lore-drop version. the module is App::Sqitch::Command::help, and it's giving perl v5.40.1 energy ✨

---

📖 SYNOPSIS

my $cmd = App::Sqitch::Command::help->new(%params);
$cmd->execute;

that's it. that's the whole vibe. make the object, run the thing 💅

---

🌸 DESCRIPTION

so if you wanna know how to use help, you lowkey want to be reading sqitch-help instead. but if you genuinely want to know how the help command works internally? read on, bestie, we're going in 🌈

---

🎀 INTERFACE

✨ Attributes

• guide — a boolean that says whether we're listing the guides or not 👑

✨ Instance Methods

💜 execute

$help->execute($command);

runs the help command. if a $command gets passed in, it shows the help for that command. and if it can't be found? Sqitch throws an error and exits. no cap, it's just gone 💀 if you don't specify a command at all, you get the Sqitch core documentation instead. cute, right? 🦋

💜 find_and_show

$help->find_and_show($file, %options);

this is the one doing the actual legwork: it finds the pod file $file and hands it off to Pod::Usage, along with any extra options meant for Pod::Usage's constructor. she's the main character of the file-fetching pipeline, fr fr 🧚

---

🌟 SEE ALSO

• sqitch-help — the docs for the help command in the Sqitch command-line client ✅
• sqitch — the Sqitch command-line client itself ✅

---

🌸 AUTHOR

David E. Wheeler <david@justatheory.com> 💖

---

👑 LICENSE

Copyright (c) 2012-2026 David E. Wheeler, 2012-2021 iovation Inc.

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.

---

and that's the whole page, bestie 💜 this one's from perl v5.40.1, dated 2026-07-26, and it's the App::S...::help(3pm) page — stay iconic, mwah 🎀✨🫶