{"id":16974339,"url":"https://github.com/jcrd/awesome-ez","last_synced_at":"2026-02-19T04:30:17.097Z","repository":{"id":97083239,"uuid":"188254415","full_name":"jcrd/awesome-ez","owner":"jcrd","description":"AwesomeWM library for simplifying key and button binding definitions","archived":false,"fork":false,"pushed_at":"2022-09-02T19:59:37.000Z","size":50,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-22T16:09:03.895Z","etag":null,"topics":["awesomewm","lua"],"latest_commit_sha":null,"homepage":"https://jcrd.github.io/awesome-ez/","language":"Lua","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/jcrd.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}},"created_at":"2019-05-23T14:51:33.000Z","updated_at":"2024-02-13T19:10:29.000Z","dependencies_parsed_at":"2024-01-14T13:38:03.325Z","dependency_job_id":"92f3c405-f640-494c-bdf9-6fd294230fd7","html_url":"https://github.com/jcrd/awesome-ez","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-ez","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-ez/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-ez/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-ez/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcrd","download_url":"https://codeload.github.com/jcrd/awesome-ez/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239680976,"owners_count":19679508,"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":["awesomewm","lua"],"created_at":"2024-10-14T01:06:16.109Z","updated_at":"2026-02-19T04:30:17.039Z","avatar_url":"https://github.com/jcrd.png","language":"Lua","funding_links":[],"categories":["Configuration Related"],"sub_categories":["Projects that Ease Configuration"],"readme":"# awesome-ez\n\nawesome-ez is a library for [Awesome](https://github.com/awesomeWM/awesome)\nwindow manager that aims to simplify the creation of key and button bindings.\nIt is based on code from the old Awesome wiki.\n\n## Installation\n\nInstall the latest stable release with `luarocks`:\n\n```sh\nluarocks install awesome-ez\n```\n\n## Usage\n\nRequire the library:\n\n```lua\nlocal ez = require(\"awesome-ez\")\n```\n\nUse `ez.keytable` to define key bindings:\n\n```lua\nlocal globalkeys = ez.keytable {\n    [\"M-Return\"] = {awful.spawn, \"xterm\"},\n    ...\n}\n```\n\nUse `ez.btntable` to define button bindings:\n\n```lua\nlocal clientbtns = ez.btntable {\n    [\"1\"] = function (c) client.focus = c end,\n    [\"M-1\"] = awful.mouse.client.move,\n    [\"M-3\"] = awful.mouse.client.resize,\n}\n```\n\nBinding definition strings consist of modifier characters and a key or button\nseparated by hyphens, e.g. `M-S-x` is the combination of `Mod4`, `Shift`, and\nthe `x` key.\n\nSee the [API documentation](https://jcrd.github.io/awesome-ez/) for\ndescriptions of all functions.\n\n### Modifiers\n\nThe following modifiers can be identified by their default shorthand characters\nin key and button definitions:\n\nCharacter | Modifier\n--------- | --------\nM         | Mod4\nA         | Mod1\nS         | Shift\nC         | Control\n\nThe `modifiers` table can be customized:\n\n```lua\nez.modifiers[\"M\"] = \"Mod1\"\n```\n\n## License\n\nThis project is licensed under the MIT License (see [LICENSE](LICENSE)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcrd%2Fawesome-ez","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcrd%2Fawesome-ez","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcrd%2Fawesome-ez/lists"}