{"id":13492088,"url":"https://github.com/hyprland-community/Hyprkeys","last_synced_at":"2025-03-28T09:33:45.396Z","repository":{"id":108153066,"uuid":"552937986","full_name":"hyprland-community/Hyprkeys","owner":"hyprland-community","description":"A simple, scriptable keybind retrieval utility for Hyprland  [maintainer=none]","archived":true,"fork":false,"pushed_at":"2024-08-30T13:57:23.000Z","size":176,"stargazers_count":121,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-31T06:34:43.557Z","etag":null,"topics":["go","hyprland","wayland","wlroots"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyprland-community.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}},"created_at":"2022-10-17T13:11:11.000Z","updated_at":"2024-10-18T00:08:18.000Z","dependencies_parsed_at":"2024-06-19T05:23:18.900Z","dependency_job_id":null,"html_url":"https://github.com/hyprland-community/Hyprkeys","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyprland-community%2FHyprkeys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyprland-community%2FHyprkeys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyprland-community%2FHyprkeys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyprland-community%2FHyprkeys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyprland-community","download_url":"https://codeload.github.com/hyprland-community/Hyprkeys/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246004112,"owners_count":20708134,"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":["go","hyprland","wayland","wlroots"],"created_at":"2024-07-31T19:01:03.014Z","updated_at":"2025-03-28T09:33:45.042Z","avatar_url":"https://github.com/hyprland-community.png","language":"Go","funding_links":[],"categories":["Tools","Go"],"sub_categories":["Input"],"readme":"# ⌨️ Hyprkeys\n\nA simple, fast and scriptable keybind inspection utility for\n[Hyprland](https://github.com/hyprwm/Hyprland)\n\n\u003c!-- deno-fmt-ignore-start --\u003e\n\n\u003e [!WARNING]\n\u003e Hyprkeys has been **deprecated** as of June 2024. This has to do with the fact\n\u003e that it was unmaintained for a while now, and that I am no longer interested\n\u003e in maintaining the project. This repository will not go anywhere, however we\n\u003e will no longer be taking contributions as Hyprkeys' functionaity is **now built\n\u003e into Hyprland**! Thank you for your continued support.\n\n\u003c!-- deno-fmt-ignore-end --\u003e\n\n## Installation \u0026 Usage\n\n### From source\n\n1. Download Go. You can obtain it from your distro's package manager. It is\n   named \"go\" under most distros.\n2. Clone this repository with\n   `git clone https://github.com/hyprland-community/hyprkeys`\n3. Install the application with `make build` then `sudo make install`\n4. You can run the application with `hyprkeys`\n\n### Using the Nix Flake\n\n```nix\n# flake.nix\n{\n  inputs = {\n    nixpkgs.url = \"github:NixOS/nixpkgs/nixos-unstable\";\n    hyprkeys = {\n        url = \"github:hyprland-community/hyprkeys\";\n        inputs.nixpkgs.follows = \"nixpkgs\";\n    };\n  };\n\n  outputs = { self, nixpkgs, hyprkeys }: let\n  in {\n    nixosConfigurations.yourHostName = nixpkgs.lib.nixosSystem {\n      # ...\n\n      environment.systemPackages = [ hyprkeys.packages.${system}.hyprkeys ];\n\n      # ...\n    };\n  };\n}\n```\n\n### Arch AUR Package\n\nArch User Repository [package](https://aur.archlinux.org/packages/hyprkeys) is\nmaintained by [bloominstrong](https://github.com/bloominstrong)\n\n```\ngit clone https://aur.archlinux.org/hyprkeys.git\ncd hyprkeys\n# Get needed dependencies, make and install hyprkeys\nmakepkg -si\n```\n\n### Installing Prebuild Binaries\n\nPrebuilt binaries are distributed for each tagged release. You may find them\nunder [releases](https://github.com/hyprland-community/Hyprkeys/releases)\n\n## Usage\n\nSee `hyprkeys -v` for a full list of commands and flags.\n\n## Project Demo\n\nhttps://user-images.githubusercontent.com/86447830/211897915-778e9b24-061d-4d97-bc5e-444224610566.mp4\n\n### Rofi script using hyprctl:\n\n![OrCEzxZ - Imgur](https://user-images.githubusercontent.com/86447830/211898056-3bdb2f11-f7f5-4854-871f-4eabaa5b898f.png)\n\n## Example Outputs (as of 11 JAN 2023)\n\n**[MARKDOWN](test/out.md)**\n\n**[JSON](test/out.json)**\n\n**[RAW](test/out.txt)**\n\n## Project Roadmap\n\nSee [TODO](TODO.md).\n\n## License\n\nThis project is licensed under the GPLv3 License. See the [LICENSE](LICENSE)\nfile for more details.\n\n## Contributing\n\nContributions, in form of **Pull Requests** and **Issues**, are always welcome.\nIf you wish to make changes, open a pull request and I will guide you through\nit.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyprland-community%2FHyprkeys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyprland-community%2FHyprkeys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyprland-community%2FHyprkeys/lists"}