{"id":24896794,"url":"https://github.com/jas-singhfsu/hyprpanel","last_synced_at":"2025-05-14T11:09:06.002Z","repository":{"id":243496090,"uuid":"812554671","full_name":"Jas-SinghFSU/HyprPanel","owner":"Jas-SinghFSU","description":"A Bar/Panel for Hyprland with extensive customizability.","archived":false,"fork":false,"pushed_at":"2025-04-13T03:02:59.000Z","size":13316,"stargazers_count":1475,"open_issues_count":146,"forks_count":138,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-13T03:40:21.360Z","etag":null,"topics":["ags","astal","catppuccin","dracula","everforest","gjs","gruvbox","gtk3","hyprland","linux","nord","onedark","rose-pine","setup","shell","tokyonight","unix","unixporn"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jas-SinghFSU.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-09T08:24:21.000Z","updated_at":"2025-04-13T03:03:01.000Z","dependencies_parsed_at":"2025-04-13T03:36:36.520Z","dependency_job_id":null,"html_url":"https://github.com/Jas-SinghFSU/HyprPanel","commit_stats":null,"previous_names":["jas-singhfsu/ags","jas-singhfsu/ags-top-panel","jas-singhfsu/hyperpanel","jas-singhfsu/hyprpanel"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jas-SinghFSU%2FHyprPanel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jas-SinghFSU%2FHyprPanel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jas-SinghFSU%2FHyprPanel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jas-SinghFSU%2FHyprPanel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jas-SinghFSU","download_url":"https://codeload.github.com/Jas-SinghFSU/HyprPanel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248717237,"owners_count":21150389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ags","astal","catppuccin","dracula","everforest","gjs","gruvbox","gtk3","hyprland","linux","nord","onedark","rose-pine","setup","shell","tokyonight","unix","unixporn"],"created_at":"2025-02-01T20:15:14.467Z","updated_at":"2025-04-13T13:12:59.044Z","avatar_url":"https://github.com/Jas-SinghFSU.png","language":"TypeScript","funding_links":["https://ko-fi.com/aylur"],"categories":[],"sub_categories":[],"readme":"\u003e ⚠️ **Seeking NixOS Maintainer** ⚠️\n\u003e\n\u003e HyprPanel is currently looking for a NixOS maintainer to help stabilize and maintain the NixOS integration. If you have experience with Nix and would like to contribute, please reach out to me via the HyprPanel discord.\n\n# HyprPanel 🚀\n\nA panel built for Hyprland with [Astal](https://github.com/Aylur/astal)\n\n![HyprPanel1](./assets/hp1.png)\n![HyprPanel2](./assets/hp2.png)\n\n\u003e NOTE: If you would like to support the project, please instead [donate to Aylur](https://ko-fi.com/aylur) who put in tremendous effort to build AGS. Hyprpanel likely wouldn't exist without it.\n\n## Information\n\nThe [HyprPanel Wiki](https://hyprpanel.com/getting_started/installation.html) contains in depth instructions for configuring and installing the panel and all of its dependencies. The instructions below are just the general instructions for installing the panel.\n\n## Arch\n\n```bash\nyay -S ags-hyprpanel-git\n```\n\n## From Source\n\n### Required\n\n```sh\naylurs-gtk-shell-git\nwireplumber\nlibgtop\nbluez\nbluez-utils\nnetworkmanager\ndart-sass\nwl-clipboard\nupower\ngvfs\n```\n\n**NOTE: HyprPanel will not run without the required dependencies.**\n\n### Optional\n\n```sh\n## Used for Tracking GPU Usage in your Dashboard (NVidia only)\npython\npython-gpustat\n\n## To control screen/keyboard brightness\nbrightnessctl\n\n## Only if a pywal hook from wallpaper changes applied through settings is desired\npywal\n\n## To check for pacman updates in the default script used in the updates module\npacman-contrib\n\n## To switch between power profiles in the battery module\npower-profiles-daemon\n\n## To take snapshots with the default snapshot shortcut in the dashboard\ngrimblast\n\n## To record screen through the dashboard record shortcut\nwf-recorder\n\n## To enable the eyedropper color picker with the default snapshot shortcut in the dashboard\nhyprpicker\n\n## To enable hyprland's very own blue light filter\nhyprsunset\n\n## To click resource/stat bars in the dashboard and open btop\nbtop\n\n## To enable matugen based color theming\nmatugen\n\n## To enable matugen based color theming and setting wallpapers\nswww\n```\n\n### Arch\n\npacman:\n\n```bash\n sudo pacman -S --needed wireplumber libgtop bluez bluez-utils btop networkmanager dart-sass wl-clipboard brightnessctl swww python upower pacman-contrib power-profiles-daemon gvfs\n```\n\nAUR:\n\n```bash\nyay -S --needed aylurs-gtk-shell-git grimblast-git wf-recorder-git hyprpicker matugen-bin python-gpustat hyprsunset-git\n```\n\n### Fedora\n\nCOPR - Add [solopasha/hyprland](https://copr.fedorainfracloud.org/coprs/solopasha/hyprland/) for most hyprland-related dependencies, and [hues-sueh/packages](https://copr.fedorainfracloud.org/coprs/heus-sueh/packages/) for matugen. Both provide the `swww` package, so prioritise the former repo:\n\n```bash\nsudo dnf copr enable solopasha/hyprland\nsudo dnf copr enable heus-sueh/packages\nsudo dnf config-manager --save --setopt=copr:copr.fedorainfracloud.org:heus-sueh:packages.priority=200\n```\n\nDNF:\n\n```sh\nsudo dnf install wireplumber upower libgtop2 bluez bluez-tools grimblast hyprpicker btop NetworkManager wl-clipboard swww brightnessctl gnome-bluetooth aylurs-gtk-shell power-profiles-daemon gvfs nodejs wf-recorder\n```\n\nnpm:\n\n```bash\nnpm install -g sass\n```\n\n#### Optional Dependencies\n\npip:\n\n```bash\nsudo dnf install python python3-pip; pip install gpustat pywal\n```\n\n### NixOS\n\nFor NixOS/Home-Manager, see [NixOS \u0026 Home-Manager instructions](#nixos--home-manager).\n\n## Installation\n\nTo install HyprPanel, you can run the following commands:\n\n```bash\ngit clone https://github.com/Jas-SinghFSU/HyprPanel.git\ncd HyprPanel\nmeson setup build\nmeson compile -C build\nmeson install -C build\n```\n\n### Installing NerdFonts\n\nHyprPanel uses [Nerdfonts](https://www.nerdfonts.com/) to display icons. You can install them using the following command from within the HyprPanel's `scripts` directory:\n\n```sh\n# Installs the JetBrainsMono NerdFonts used for icons\n./scripts/install_fonts.sh\n```\n\nIf you install the fonts after installing HyperPanel, you will need to restart HyperPanel for the changes to take effect.\n\n### NixOS \u0026 Home-Manager\n\nAlternatively, if you're using NixOS and/or Home-Manager, you can setup AGS using the provided Nix Flake. First, add the repository to your Flake's inputs, and enable the overlay.\n\n```nix\n# flake.nix\n\n{\n  inputs.hyprpanel.url = \"github:Jas-SinghFSU/HyprPanel\";\n  # ...\n\n  outputs = { self, nixpkgs, ... }@inputs:\n  let\n    # ...\n system = \"x86_64-linux\"; # change to whatever your system should be.\n    pkgs = import nixpkgs {\n   inherit system;\n   # ...\n   overlays = [\n        inputs.hyprpanel.overlay\n   ];\n };\n  in {\n    # ...\n  }\n}\n```\n\nOnce you've set up the overlay, you can reference HyprPanel with `pkgs.hyprpanel` as if it were any other Nix package. This means you can reference it as a NixOS system/user package, a Home-Manager user package, or as a direct reference in your Hyprland configuration (if your configuration is managed by Home-Manager). The first three methods will add it to your `$PATH` (first globally, second two user-only), however the final will not.\n\n```nix\n# configuration.nix\n\n# install it as a system package\nenvironment.systemPackages = with pkgs; [\n  # ...\n  hyprpanel\n  # ...\n];\n\n# or install it as a user package\nusers.users.\u003cusername\u003e.packages = with pkgs; [\n  # ...\n  hyprpanel\n  # ...\n];\n\n\n# home.nix\n\n# install it as a user package with home-manager\nhome.packages = with pkgs; [\n  # ...\n  hyprpanel\n  # ...\n];\n\n# or reference it directly in your Hyprland configuration\nwayland.windowManager.hyprland.settings.exec-once = [\n  \"${pkgs.hyprpanel}/bin/hyprpanel\"\n];\n\n```\n\nFor information on the Home Manager module, click [here](https://hyprpanel.com/getting_started/installation.html#nixos-home-manager).\n\n### Launch the panel\n\nAfterwards you can run the panel with the following command in your terminal:\n\n```bash\nhyprpanel\n```\n\nOr you can add it to your Hyprland config (hyprland.conf) to auto-start with:\n\n```bash\nexec-once = hyprpanel\n```\n\n### Notifications\n\nHyprPanel handles notifications through the AGS built-in notification service. If you're already using a notification daemon such as Dunst or Mako, you may have to stop them to prevent conflicts with HyprPanel.\n\n\u003e NOTE: If your system is in a language other than English, the resource monitor in the dashboard may not work properly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjas-singhfsu%2Fhyprpanel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjas-singhfsu%2Fhyprpanel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjas-singhfsu%2Fhyprpanel/lists"}