App::S...nd::add(3pm)

✨ NAME ✨

App::Sqitch::Command::add — the class that adds a brand-new change to Sqitch plans, bestie. That's it, that's the whole job. 🫶

(oh and hi, this is the App::S...nd::add(3pm) page from the User Contributed Perl Documentation, so you know it's legit ⭐)

---

🎀 SYNOPSIS 🎀

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

---

🌸 DESCRIPTION 🌸

okay so listen. This adds a new deployment change. What does that actually mean, you ask? It means it results in the creation of a scripts in the deploy, revert, and verify directories. 💅

And those scripts? They're based on Template::Tiny templates chilling in ~/.sqitch/templates/ or "$(prefix)/etc/sqitch/templates". Not sure which one's being used on your machine? No worries — just call sqitch --etc-path and it'll tell you where, exactly (like, for example, "$(sqitch --etc-path)/sqitch.conf"). 🦋

---

💜 INTERFACE 💜

Class Methods

options

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

Returns a list of Getopt::Long option specifications for the command-line options for the add command. Slay.

configure

my $params = App::Sqitch::Command::add->configure(
    $config,
    $options,
);

Processes the configuration and the command options, then hands you back a hash that's suitable for the constructor. Iconic, honestly.

Attributes 👑

change_name

The name of the change that's being added. Literally the whole point. 💖

note

Text of the change note. 📝

requires

List of required changes.

conflicts

List of conflicting changes. Not me showing up where I'm not wanted 🙈

all

Boolean indicating whether or not to run the command against all plans in the project. all or nothing, periodt.

template_name

The name of the templates to use when generating scripts. Defaults to the engine for which the scripts are being generated.

template_directory

Directory in which to find the change script templates.

with_scripts

Hash reference indicating which scripts to create.

Instance Methods 🌟

execute

$add->execute($command);

Executes the add command. main character energy fr fr.

all_templates

Returns a hash reference of script names mapped to template files for all scripts that should be generated for the new change. ✨

---

🔥 SEE ALSO 🔥

• sqitch-add — Documentation for the add command to the Sqitch command-line client.
• sqitch — The Sqitch command-line client.

---

💖 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 page!! 🎀 this manual was brought to you by perl v5.40.1, dated 2026-07-26. go add a change, bestie, you got this 💜🦋