UR::Na...Browser(3pm)

📦
version 0.470 · 2 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

🌸 UR::Namespace::Command::Sys::ClassBrowser 🌸

okay bestie, welcome to the User Contributed Perl Documentation page for UR::Namespace::Command::Sys::ClassBrowser — yeah that name is a whole mouthful, we're just gonna call it the class browser, iykyk. It's literally a WebApp for browsing the class structure. That's the whole vibe. 👑

✨ SYNOPSIS ✨

# Start the web server
ur sys class-browser

# Create the cache file for the current namespace
ur sys class-browser --generate-cache

💖 DESCRIPTION 💖

so the class-browser command spins up an embedded web server that's holding a lil app for browsing through your class structure. once it's up and running, it prints a URL on STDOUT that you can just copy-and-paste straight into a browser to run the app. that's it, that's the magic. ✨🦋

🎀 COMMAND-LINE OPTIONS 🎀

With no options at all, the command expects to be run within a Namespace directory. It'll auto-discover every single class in the Namespace — either from a cache file somebody already made, or by scanning all the perl modules inside the Namespace's subdirectory. It's giving resourceful. 💅

  • --generate-cache — instead of starting a web server, the command scans for all perl modules within the Namespace's subdirectory and creates a file called .<namespace>-class-browser-cache, then exits. That file holds info about all the classes it found, which makes start-up way faster the next time you run the command. lowkey the glow-up. ⚡
  • --port <port> — change the TCP port the web server listens on. The default is 8080. 🌈
  • --nouse-cache — the command will use the cache file generated by the --generate-cache option if it finds one. But when --nouse-cache is used, it will always scan for perl modules and will ignore any cache that may be present. no shortcuts, we do it live. 💀
  • --verbose — causes the command to print the STDOUT the URLs loaded while it is running. chatty queen. 🗣️✨

🫶 SEE ALSO 🫶

  • UR
  • UR::Object::Type
  • UR::Service::WebServer
ngl, if you're in a Namespace directory and you just want to see your classes, run the thing, grab the URL, and go. main character energy only. 👑

mwah 💜 that's the whole page, bestie — brought to you by perl v5.32.1, dated 2022-01-17, from the good people who wrote UR::Na...Browser(3pm). periodt. 🎀🌸

📦 where this page comes from