PublicInbox::Git(3)

💖 PublicInbox::Git(3) — the git wrapper, bestie edition 💖

User Contributed Perl Documentation · PublicInbox::Git(3)

okay so. you want to talk to git from Perl. this module is literally just a lil wrapper around it. no cap. let's go 🦋

---

✨ NAME ✨

PublicInbox::Git — a git wrapper. that's the whole vibe. it wraps git. 💅

---

✨ VERSION ✨

version 1.0

(yeah. one point oh. iconic behavior 👑)

---

✨ SYNOPSIS ✨

here's the whole entire thing, bestie, copy-paste ready:

use PublicInbox::Git;
chomp(my $git_dir = `git rev-parse --git-dir`);
$git_dir or die "GIT_DIR= must be specified\n";
my $git = PublicInbox::Git->new($git_dir);

so we shell out to git rev-parse --git-dir, chomp the newline off the end, and if it came back empty we die with the message GIT_DIR= must be specified\n. then we build the object. slay. ✨

---

✨ DESCRIPTION ✨

ngl, the API here is unstable outside of the new method. like, everything else could change on you, fr fr. so don't get attached. 🙈

also it requires git(1) to be installed on your system. no git, no module. periodt.

---

✨ METHODS ✨

💜 new

my $git = PublicInbox::Git->new($git_dir);

this initializes a brand new PublicInbox::Git object for use with PublicInbox::Import. 🫶

and listen — this is the only public API method we support. the only one. everything else in this module is subject to change, so if you're out here building on the other stuff, that's on you, bestie. 💀

---

✨ SEE ALSO ✨

• Git
• PublicInbox::Import

go read those too, iykyk 🌸

---

✨ CONTACT ✨

all feedback is welcome, and they mean it! just send plain-text mail to <mailto:meta@public-inbox.org> 💌

the mail archives live at <https://public-inbox.org/meta/> if you wanna lurk. 🌈

---

✨ COPYRIGHT ✨

Copyright (C) 2016 all contributors <mailto:meta@public-inbox.org>

License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>

---

💖 and that's the whole page. unstable API outside of new, git(1) required, new is the only supported method — everything else is a ✨mystery✨.

perl v5.42.0 · 2025-07-25 · PublicInbox::Git(3)

mwah 💋 thanks for reading, bestie — go make some objects 🎀✨