sqitch-tag(3pm)

💖 sqitch-tag(3pm) 💖

okay so this is the manual page for sqitch-tag, part of the User Contributed Perl Documentation, and bestie, it's literally about creating or listing tag objects. let's get into it 🎀

---

✨ NAME ✨

sqitch-tag — Create or list tag objects

---

🌸 SYNOPSIS 🌸

sqitch tag [options]
sqitch tag <name>
sqitch tag <name> change --note <note>
sqitch tag --tag <name> --change <change>
sqitch tag <name> --all

---

🦋 DESCRIPTION 🦋

So what this does is it tags a change, or it outputs a list of the existing tags in one or more project plans. Tagging is the move when you're getting ready for a release, and also — plot twist — tags are required if you want to rework a change. no tags, no rework, periodt.

To specify a change, you use a change specification exactly like the one documented in sqitchchanges. If you call it with a tag name but no change, then the most recent change in each plan gets tagged. And if you call it with no name at all? It just prints out a list of the current tags. easy.

heads up though: the name of your new tag has to follow the rules defined in sqitchchanges. no freestyling the tag names, bestie, the rules are the rules 💅

By default, the tag command adds a new tag to the project's default plan — that's the one defined by the core configuration and the command-line options. Pass the --all option and it'll instead iterate over all known targets, either listing tags or adding a tag to all the plans. This is the iconic move for keeping tags in sync across all your plan files. 👑

Wanna say which plans to tag? Just pass the target, engine, or plan file names as arguments. And if you need to disambiguate the tag name and change name from all those other parameters (or if it's just, like, preferable), reach for --tag and --change. Check "Examples" for, well, examples. 🍓

---

💅 OPTIONS 💅

• -t, --tag, --tag-name — the name of the tag you're adding. You can pass the name with or without this option, but the option is lowkey useful for disambiguating the tag name from the other arguments.
• -c, --change, --change-name — the name of the change you want to tag. Again, you can pass the name with or without this option, but the option helps disambiguate the change name from the other arguments.
• -a, --all — list the tags, or add the new tag to every plan in a project. You literally cannot mix this with target, engine, or plan file name arguments — doing that is an error, and not the cute kind. It's the move for multi-plan projects where tags should stay in sync. It overrides the value of the tag.all configuration; use --no-all to override a true tag.all configuration.
• -n, --note — a brief note describing the tag. The note gets attached to the tag as a comment. And if you invoke it multiple times, all those notes get concatenated together as separate paragraphs. 🫶

For all you Git folks out there: -m also works. iykyk.

• --plan-file, -f — path to the deployment plan file. This overrides target, engine, and core configuration values. Defaults to $top_dir/sqitch.plan.

---

🌈 CONFIGURATION VARIABLES 🌈

tag.all

List the tags, or add the new tag to all the plans in a project. This is the vibe for multi-plan projects where tags should be kept in sync. It may be overridden by --all, --no-all, or by target, engine, and plan file name arguments.

---

⭐ EXAMPLES ⭐

Get a list of tags in the default project plan:

sqitch tag

Get a list of all tags in the project:

sqitch tag --all

Get a list of the tags in the plan used by the pg engine:

sqitch tag pg

Get a list of the tags in two specific plans:

sqitch tag sqlite.plan pg.plan

Tag the latest change in the default project plan and be prompted for a note.

sqitch tag alpha1

Tag the latest change in all project plans and be prompted for a note.

sqitch tag alpha1 --all

Tag the latest change in the default project plan and and specify the note.

sqitch tag alpha2 -n 'Tag @alpha2.'

Tag change users in the default plan:

sqitch tag --tag alpha3 --change users

Tag the latest change change in the project plan used by the vertica engine:

sqitch tag --tag beta1 vertica -n 'Tag the Vertica with @beta1.'

Tag the latest change in two plans in a project:

sqitch tag -t v1.0.1 sqlite.plan pg.plan -n 'Tag @v1.0.1.'

---

🙈 CONFIGURATION VARIABLES 🙈

None currently.

(yes, it's a second Configuration Variables section. the original said it, so we say it. slay.)

---

👑 SQITCH 👑

Part of the sqitch suite.

---

and that's the whole page, bestie 💖 this was sqitch-tag(3pm), from perl v5.40.1, dated 2026-07-26 — go forth and tag your changes, no cap 🌸✨