HyprProf — Hyprland's profile manager 🛠️

What is a Profile?

Definition: A profile in HyprProf is a structured representation of a complete Hyprland environment. It serves as a domain-specific abstraction that allows the system to manage, deploy, and share environments reliably and reproducibly.

Core Components of a Profile

• Name — unique identifier of the profile.
• Version — version of the profile, useful for tracking updates.
• Authors — creators or maintainers of the profile.
• Description — textual explanation of the profile's purpose.
• Hypr Configuration (hypr/) — settings and dotfiles for the Hyprland compositor.
• Wayland Constraints (wayland/) — compatible Wayland versions.
• Dotfiles — additional configurations for terminal, bar, launcher, and other components.

Purpose: Profiles allow HyprProf to automate the deployment of complete environments, ensure consistency across systems, and facilitate sharing or version control of user setups.

Features ✨

• Core Components Configuration: Set up your terminal, launcher, notification system, and status bar effortlessly.
• Providers: Control your wallpaper, screenshots, clipboard, and screen recording tools.
• Build Scripts: Automate installations, uninstallations, and other setup spells.
• Version Constraints: Make sure your profile only works with Hyprland or Wayland versions that won't break your magic.
• Portable & Shareable: Move profiles across systems without losing your mojo.

Getting Started 🚀

Quick Installation

Clone, build, and install in one swoop:

git clone https://github.com/KiamMota/hyprprof.git
cd hyprprof

mkdir build
cd build
cmake ..                 # configure
make -j$(nproc)          # build
sudo make install         # install binary and configs

cd ..
rm -rf ./*               # clean up leftover junk

Repository Setup

Prefer just cloning and running a script? Easy:

git clone https://github.com/KiamMota/hyprprof.git
cd hyprprof
./install.sh

CLI Commands 🧙‍♂️

• install <path/url> — Bring a profile from somewhere else into your system.
• use <name> — Activate a profile to cast its magic.
• using — See which profile is currently active.
• list — Peek at all your installed profiles.
• remove <name|current> — Delete a profile that you no longer need.

Documentation

For the nerdy deep-dive:

• Start here!

Go forth, young wizard, and make your Hyprland experience magical!