Shipwri...kend::FS(3)

🦋 NAME 🦋

ok so bestie, meet Shipwright::Backend::FS — the File System backend for Shipwright, living in section 3 of the manual (that's the "User Contributed Perl Documentation" corner of the docs, iykyk). She's the one who keeps your repo on plain old disk. ✨

---

✨ SYNOPSIS ✨

shipwright create -r fs:/home/me/shipwright/my_project

that's it. that's the whole vibe. one command and you've got a project chilling at /home/me/shipwright/my_project. 🫶

---

🌸 DESCRIPTION 🌸

This module implements a file system based backend for a Shipwright repository — and yes, with version control on top. so like. files on disk, but make it tracked. the way that it just... stores your repo on the filesystem?? iconic. 💅

---

🎀 METHODS 🎀

here's the roster, no notes, every single one of them:

• build — she's here. that's the listing. 💖
• initialize — Initialize a project. fresh start energy, main character origin story. ✨
• _yml — also on the list. (the underscore is giving "internal, don't @ me" but we don't speculate, we just report. 🙈)
• info — listed. present. accounted for. 🌈
• check_repository — Check if the given repository is valid. basically the vibe check for your repo. 🫶
• import — and last but never least, she's on the list too. 🔥

ngl the original page is ✨ mysterious ✨ about most of these — no extra descriptions were given, so we are NOT inventing lore. what you see is what's canon. periodt. 💀

---

👑 AUTHORS 👑

sunnavy <sunnavy@bestpractical.com> — the legend, the blueprint, the moment. 🎀

---

🧚 LICENCE AND COPYRIGHT 🧚

Shipwright is Copyright 2007-2015 Best Practical Solutions, LLC.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. so like, go forth and remix, respectfully. 💜

---

and that's the whole page, bestie — this one came out under perl v5.42.0 and got stamped 2025-07-25, from that same "User Contributed Perl Documentation" collection we met at the top. slay, read responsibly, and go create a repo. 🌸💖🦋