{"id":13673713,"url":"https://jcrd.github.io/awesome-launch/","last_synced_at":"2025-04-28T11:30:39.352Z","repository":{"id":97083451,"uuid":"178222952","full_name":"jcrd/awesome-launch","owner":"jcrd","description":"AwesomeWM library for launching clients with single instance IDs","archived":false,"fork":false,"pushed_at":"2021-11-07T22:56:26.000Z","size":142,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-23T15:02:08.134Z","etag":null,"topics":["awesomewm","lua"],"latest_commit_sha":null,"homepage":"https://jcrd.github.io/awesome-launch/","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-03-28T14:42:06.000Z","updated_at":"2025-03-05T15:35:38.000Z","dependencies_parsed_at":"2024-01-14T13:37:57.852Z","dependency_job_id":"e18da77c-3e4d-4e2c-b239-a86a8cffacd5","html_url":"https://github.com/jcrd/awesome-launch","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-launch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-launch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-launch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcrd%2Fawesome-launch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcrd","download_url":"https://codeload.github.com/jcrd/awesome-launch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304665,"owners_count":21567918,"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-08-02T11:00:19.868Z","updated_at":"2025-04-28T11:30:38.892Z","avatar_url":"https://github.com/jcrd.png","language":"Lua","funding_links":[],"categories":["Usage"],"sub_categories":[],"readme":"# awesome-launch\n\nawesome-launch is a library for [Awesome](https://github.com/awesomeWM/awesome)\nwindow manager that provides functions to spawn clients with single instance\nIDs using [wm-launch](https://github.com/jcrd/wm-launch).\n\n## Dependencies\n\n* [uuid](https://luarocks.org/modules/tieske/uuid) rock\n* [wm-launch](https://github.com/jcrd/wm-launch) \u003e= 0.5.0\n\n## Installation\n\n```\n$ git clone https://github.com/jcrd/awesome-launch.git\n$ cd awesome-launch\n$ luarocks make --local rockspec/awesome-launch-devel-1.rockspec\n```\n\n## Usage\n\nRequire the library:\n```lua\nlocal launch = require(\"awesome-launch\")\n```\n\nNow spawn a client:\n```lua\nlaunch.spawn(\"xterm\", {id=\"xterm1\"})\n```\nThe new client will have these properties set:\n* `single_instance_id` = `\"xterm1\"`\n* `cmdline` = `\"xterm\"`\n\nSee the [API documentation](https://jcrd.github.io/awesome-launch/) for\ndescriptions of all functions.\n\n## Workspaces\n\nRequire the library:\n```lua\nlocal ws = require(\"awesome-launch.workspace\")\n```\n\nAdd a new workspace:\n```lua\nws.add(\"code\", {\n  pwd = \"/home/user/code\",\n  clients = {\n    \"xterm -e vim\",\n    {\"qutebrowser\", {factory=\"qutebrowser\"}},\n  }\n})\n```\n\nA new tag named `code` will be created with the working directory and clients\nlisted above.\n\n## Widget\n\nA `launchbar` widget is provided to visualize pending clients.\n\nCustomize the launchbar:\n```lua\nlaunch.widget.color = beautiful.fg_focus\n```\n\nCreate a new launchbar for the given screen:\n```lua\nscreen.connect_signal(\"request::desktop_decoration\", function (s)\n  ...\n  s.launchbar = launch.widget.launchbar {\n    screen = s,\n  }\n  s.mywibox:setup {\n    ...\n    s.launchbar,\n    ...\n  }\nend)\n```\n\n## Command-line client\n\n`awesome-launch` is a wrapper around `awesome-client` that can be used to\nlaunch clients from the command line with single instance IDs tracked by\nAwesome.\n\n### Usage\n\n```\nusage: awesome-launch [options] COMMAND...\n\noptions:\n  -h          Show help message\n  -s          Launch with systemd-run\n  -j          Launch with firejail\n  -f FACTORY  Launch via a window factory\n  -i ID       The single instance ID to use\n  -1          Spawn if not already running\n  -r          Raise or spawn\n```\n\nEnable use of `awesome-client` by including the following in `rc.lua`:\n```lua\nrequire(\"awful.remote\")\n```\n\nIf installed via `luarocks`, ensure `awesome-launch`'s [location][1] is in your\n`PATH`.\n\n[1]: https://github.com/luarocks/luarocks/wiki/File-locations#Path_where_commandline_scripts_are_installed\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/jcrd.github.io%2Fawesome-launch%2F","html_url":"https://awesome.ecosyste.ms/projects/jcrd.github.io%2Fawesome-launch%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/jcrd.github.io%2Fawesome-launch%2F/lists"}