App::Cleo(3pm)

✨ NAME ✨

App::Cleo — play back shell commands for live demonstrations 🎬💖

Like, it's a whole perl module (it lives in the App::Cleo(3pm) man page, bestie) that types out your shell commands for you on stage. Obsessed.

---

🌸 SYNOPSIS 🌸

  use App::Cleo
  my $cleo = App::Cleo->new(%options);
  $cleo->run($commands);

That's it. That's the whole vibe. 🫶

---

🦋 DESCRIPTION 🦋

So here's the tea ☕ — App::Cleo is the back-end for the cleo utility. The way that it's literally just the engine under the hood ✨. Please see the cleo documentation for details on how to use this. iykyk 💅

---

🎀 CONSTRUCTOR 🎀

The constructor accepts arguments as key-value pairs, so like App::Cleo->new(delay => 100, prompt => 'bestie> ') energy. 💖

The following keys are supported:

• delay — Number of milliseconds to wait before displaying each character of the command. Yep, per character, it's a whole slow-typing aesthetic 😭. The default is 25_000. (That's the exact number, no cap, underscores and all.)
• prompt — String to use for the artificial prompt. The token %d will be substituted with the number of the current command 🔢. The default is "(%d)$".
• shell — Path to the shell command that will be used to run the commands 🐚. Defaults to either the SHELL environment variable or /bin/bash.

---

👑 METHODS 👑

run( $commands )

Starts playback of commands ▶️✨. And here's the important part, so listen up: what you pass in changes everything about how it's read 🫣

• If the argument is a string, it will be treated as a file name and commands will be read from the file 📄.
• If the argument is a scalar reference, it will be treated as a string of commands separated by newlines 📝.
• If the argument is an array reference, then each element of the array will be treated as a command 🧺 (one command per element, clean and iconic).

---

💜 AUTHOR 💜

Jeffrey Ryan Thalhammer <thaljef@cpan.org> 🌈 — a legend, fr fr.

---

🌟 COPYRIGHT 🌟

Copyright (c) 2014, Imaginative Software Systems 🫶

---

okay and that's the whole page, bestie!! 💖✨ this little cutie ships as part of perl v5.40.1, dated 2025-12-10, and it's filed under the manual page App::Cleo(3pm) 🎀 go type some commands dramatically on a projector, you main character 🦋👑