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

🎀 NAME 🎀

App::Sqitch::Role::ContextCommand — bestie, it's the role for a command that needs to know where things are. That's the whole gig. Location awareness. The vibe check for your project files. 💅

(also hey, this page lives in the User Contributed Perl Documentation manual, under the name App::S...Command(3pm) — she's got a long name and the header had to abbreviate, iykyk ✨)

---

🌸 SYNOPSIS 🌸

Like, here's how you actually pull it in, no cap:

package App::Sqitch::Command::add;
extends 'App::Sqitch::Command';
with 'App::Sqitch::Role::ContextCommand';

You extends your base command, then with this role, and boom — your command suddenly knows where it is. Main character energy fr fr. 🦋

---

💖 DESCRIPTION 💖

Okay so, this role is doing a very specific little job and it's obsessed with it: it encapsulates the options and target parameters that are required by commands that need to know where to find project files.

That's it. That's the role. She's not trying to do everything, she's just handling the "where are my files tho" of it all, so the commands that actually do stuff don't have to. Queen behavior honestly 👑

---

✨ INTERFACE ✨

🧚 Class Methods

options

my @opts = App::Sqitch::Command::add->options;

Call this and you get your options back. It adds the contextual options --plan-file and --top-dir. Those two are literally the entire point of this role, so like, respect them. 🌈

configure

Configures the options used for target parameters. That's what it does — it sets up the options that the target params are gonna come from. Simple, clean, no drama. 🎀

💜 Instance Methods

target_params

Returns a list of parameters to be passed to App::Sqitch::Target's new and all_targets methods.

So basically: you hand these params over to new and all_targets and everyone's on the same page about which target we're talking about. Teamwork makes the dream work 🫶

---

🦋 SEE ALSO 🦋

• App::Sqitch::Command::add — the add command adds changes to the plan and change scripts to the project. She's the one adding stuff. 🍓
• App::Sqitch::Command::deploy — the deploy command deploys changes to a database. Sending it, fr. 🔥
• App::Sqitch::Command::bundle — the bundle command bundles Sqitch changes for distribution. Packaging it up so it can travel. 📦✨

---

🌟 AUTHOR 🌟

David E. Wheeler <david@justatheory.com> — the icon who wrote this, we stan 👑

---

💀 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.

bestie do NOT skip that paragraph, it's real legal business and it's giving "read me before you copy me" 😭

---

okay that's the whole page, we're done here 💖 this version came from perl v5.40.1, dated 2026-07-26, and it's the App::S...Command(3pm) page — go forth and know where your files are, periodt 🎀✨