{"id":15981468,"url":"https://github.com/hideoo/keyprompter","last_synced_at":"2026-05-01T14:32:40.092Z","repository":{"id":85853396,"uuid":"375654192","full_name":"HiDeoo/KeyPrompter","owner":"HiDeoo","description":"Shortcut broadcaster for OBS","archived":false,"fork":false,"pushed_at":"2021-06-21T07:02:05.000Z","size":288,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-25T15:56:35.182Z","etag":null,"topics":["broadcaster","go","obs","react","shortcut","web"],"latest_commit_sha":null,"homepage":"","language":"Go","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/HiDeoo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-06-10T10:10:57.000Z","updated_at":"2023-07-14T15:56:53.000Z","dependencies_parsed_at":"2023-03-13T07:00:02.181Z","dependency_job_id":null,"html_url":"https://github.com/HiDeoo/KeyPrompter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/HiDeoo/KeyPrompter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2FKeyPrompter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2FKeyPrompter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2FKeyPrompter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2FKeyPrompter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HiDeoo","download_url":"https://codeload.github.com/HiDeoo/KeyPrompter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2FKeyPrompter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32501399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["broadcaster","go","obs","react","shortcut","web"],"created_at":"2024-10-08T00:44:14.846Z","updated_at":"2026-05-01T14:32:40.068Z","avatar_url":"https://github.com/HiDeoo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003eKeyPrompter 📽️\u003c/h1\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://i.imgur.com/hw1oNl6.gif\" title=\"KeyPrompter\"\u003e\u003cimg alt=\"KeyPrompter\" src=\"https://i.imgur.com/hw1oNl6.gif\" width=\"500\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/HiDeoo/KeyPrompter/actions/workflows/keyprompter.yml\"\u003e\u003cimg alt=\"Integration Status\" src=\"https://github.com/HiDeoo/KeyPrompter/actions/workflows/keyprompter.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/HiDeoo/KeyPrompter/blob/master/LICENSE\"\u003e\u003cimg alt=\"License\" src=\"https://badgen.now.sh/badge/license/MIT/blue\"\u003e\u003c/a\u003e\n  \u003cbr /\u003e\u003cbr /\u003e\n\u003c/p\u003e\n\n**Broadcast your shortcuts…**\n\n## Motivations\n\nI could not find a macOS application to broadcast keyboard shortcuts to a web page so it can be easily used with various live streaming softwares so I decided to build my own.\n\nKeyPrompter is a Go application monitoring keyboard shortcuts and also serving locally a React application which can be used to visualize the pressed shortcuts using WebSocket (_only shortcuts are visible meaning typing text won't display anything_).\n\n## Installation\n\n1. [Download the latest version](https://github.com/HiDeoo/KeyPrompter/releases) matching your system architecture.\n1. Extract the downloaded archive.\n1. Optionally, move the `keyprompter` application in your `PATH` (e.g. `/usr/local/bin/`)\n1. Ensure the `keyprompter` application can be executed (e.g. `chmod +x keyprompter`).\n\n_Note: the application has been developed and tested only on macOS with a QWERTY layout and even tho it should technically work on other systems, it will probably require some adjustments and testing._\n\n## Usage\n\nYou can quickly starts the application using the following command:\n\n```plaintext\n$ keyprompter\nYou can now view the KeyPrompter UI in the browser: http://localhost:8484.\n```\n\nVarious options are available:\n\n| Option     | Default | Description                                    |\n| ---------- | ------- | ---------------------------------------------- |\n| `-p VALUE` | 8484    | Port used to run the web UI.                   |\n| `-c VALUE` | _None_  | Path to the optional client configuration file |\n| `-v`       |         | Display the application version.               |\n| `-h`       |         | Display the application options.               |\n\n## Configuration\n\nUsing the `-c` option, an optional path to a client configuration file can be passed down to the application.\n\nThe configuration is a [TOML file](https://toml.io/) where any value can be configured individually. Here is an example with the default values for each options:\n\n```toml\n# The maximum number of shortcuts to display at the same time.\nCount = 5\n\n# The duration in seconds during when a shortcut is visible on screen.\nDuration = 5\n\n# The font size in pixels used when displaying a shortcut.\nFontSize = 18\n\n# The font color used for a shortcut text (any supported CSS value).\nFontColor = \"white\"\n\n# The background color for a shortcut (any supported CSS value).\nBgColor = \"rgba(0, 0, 0, 0.6)\"\n```\n\n## Contribute\n\n1. [Fork](https://help.github.com/articles/fork-a-repo) \u0026 [clone](https://help.github.com/articles/cloning-a-repository) this repository.\n1. Make sure your Go version is at least `1.16`.\n1. Build \u0026 run the development version using `go run .`.\n\n## License\n\nLicensed under the MIT License, Copyright © HiDeoo.\n\nSee [LICENSE](https://github.com/HiDeoo/KeyPrompter/blob/master/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fkeyprompter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhideoo%2Fkeyprompter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fkeyprompter/lists"}