{"id":13896457,"url":"https://github.com/luarocks/luarocks-gui","last_synced_at":"2025-07-17T12:33:37.456Z","repository":{"id":133164265,"uuid":"134888430","full_name":"luarocks/luarocks-gui","owner":"luarocks","description":"GUI module for LuaRocks 3.x","archived":true,"fork":false,"pushed_at":"2018-08-14T06:59:56.000Z","size":443,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-25T02:32:02.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/luarocks.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}},"created_at":"2018-05-25T17:56:01.000Z","updated_at":"2024-02-16T19:23:00.000Z","dependencies_parsed_at":"2023-04-23T10:31:11.875Z","dependency_job_id":null,"html_url":"https://github.com/luarocks/luarocks-gui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/luarocks/luarocks-gui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarocks%2Fluarocks-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarocks%2Fluarocks-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarocks%2Fluarocks-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarocks%2Fluarocks-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luarocks","download_url":"https://codeload.github.com/luarocks/luarocks-gui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarocks%2Fluarocks-gui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265606790,"owners_count":23797006,"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":[],"created_at":"2024-08-06T18:02:56.274Z","updated_at":"2025-07-17T12:33:37.025Z","avatar_url":"https://github.com/luarocks.png","language":"Lua","funding_links":[],"categories":["Lua"],"sub_categories":[],"readme":"# luarocks-gui\n\nLuaRocks is a package manager for Lua. This project is a web-browser based GUI of LuaRocks that allows users to search for rocks, list installed rocks, install and remove them, view rock details, etc. It uses the LuaRocks API for interfacing with the LuaRocks back-end.\n\n## Installation\n\n1. Install the `luarocks-api` branch. Follow [these](https://github.com/luarocks/luarocks-gui/wiki/Installation-instructions#installing-the-luarocks-api-branch) instructions.\n2. Install `luarock-gui` by following [these](https://github.com/luarocks/luarocks-gui/wiki/Installation-instructions#installing-luarocks-gui) instructions.\n\n**NOTE:** This project uses the [luarocks-api](https://github.com/luarocks/luarocks/tree/luarocks-api) branch of LuaRocks. So, you need to install that branch in order to run luarocks-gui.\\\nKeep in mind that this branch is still under development, so if you come across any API issues then please report them [here](https://github.com/luarocks/luarocks/issues).\\\nThis is temporary until the the API gets merged into the main branch of LuaRocks.\n\n## Usage\n\nAfter a successful installation, run:\n```\nluarocks gui\n```\nThis will automatically open up a browser window (of your default browser) and run there.\\\nNote: By default luarocks-gui runs on port ```8080```.\n\n## GUI\n\nThe web-GUI has 5 main pages:\n\n#### Index/landing page\nThis page shows the list of rock-trees configured in your current setup.\n\n#### list rocks page\nThis page shows the list of rocks installed in all of the rock-trees in your system.\\\nYou can filter the results based on a particular rock-tree, or some keyworks/queries.\\\n\\\nEach rock has 3 buttons along with it:\n- Details: shows further details for a rock.\n- Documentation: Opens the directory containing documentation of the rock.\n- Remove: Removes the rock from LuaRocks.\n\n#### search rocks page\nThis page lets you search for any rock on the internet.\\\nShows the the list of rocks based on your query.\\\n\\\nEach rock has 2 buttons along with it:\n- View on luarocks.org: Redirects to [luarocks.org](https://luarocks.org) and with the same query you entered.\n- Install: Installs the rock. (Uses the rock-version and rock-tree you select in the drop-down menus)\n\n#### advanced page\nThis page lets you manage your [rockspec](https://github.com/luarocks/luarocks/wiki/Creating-a-rock#writing-a-rockspec) with ease.\\\nYou can:\n- lint a rockspec\n- write a new version for an existing rockspec\n- write a new rockspec\n\n#### about page\nThis page shows you the informantion about luarocks-gui.\n\n\n## Dependencies\n\nThis rock depends on:\n- [xavante](https://keplerproject.github.io/xavante/)\n- [wsapi-xavante](https://keplerproject.github.io/xavante/)\n- [cgilua](https://keplerproject.github.io/cgilua/)\n- [datafile](https://github.com/hishamhm/datafile)\n\nThis project also uses:\n- [Bulma](https://github.com/jgthms/bulma)\n- [Vue](https://github.com/vuejs/vue)\n\n--------------------------------------------------------------------\nThis project has been made under Google summer of code 2018 for LuaRocks. \\\nFeedback, pull requests, criticism, contributions, etc. are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluarocks%2Fluarocks-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluarocks%2Fluarocks-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluarocks%2Fluarocks-gui/lists"}