{"id":20173920,"url":"https://github.com/joshuar/gokbd","last_synced_at":"2025-09-19T22:53:16.271Z","repository":{"id":66394246,"uuid":"418025964","full_name":"joshuar/gokbd","owner":"joshuar","description":"A go library to manipulate keyboards using libevdev","archived":false,"fork":false,"pushed_at":"2023-10-24T10:18:07.000Z","size":76,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-28T05:46:24.805Z","etag":null,"topics":["golang","keyboard","libevdev"],"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/joshuar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"ko_fi":"astralcars"}},"created_at":"2021-10-17T05:07:06.000Z","updated_at":"2024-11-29T01:47:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"aedce766-fd25-4cd9-9771-b10b70589848","html_url":"https://github.com/joshuar/gokbd","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/joshuar/gokbd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuar%2Fgokbd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuar%2Fgokbd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuar%2Fgokbd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuar%2Fgokbd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshuar","download_url":"https://codeload.github.com/joshuar/gokbd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshuar%2Fgokbd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276012399,"owners_count":25569844,"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","status":"online","status_checked_at":"2025-09-19T02:00:09.700Z","response_time":108,"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":["golang","keyboard","libevdev"],"created_at":"2024-11-14T01:38:35.445Z","updated_at":"2025-09-19T22:53:16.229Z","avatar_url":"https://github.com/joshuar.png","language":"Go","funding_links":["https://ko-fi.com/astralcars"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n Copyright (c) 2023 Joshua Rich \u003cjoshua.rich@gmail.com\u003e\n \n This software is released under the MIT License.\n https://opensource.org/licenses/MIT\n--\u003e\n\n# gokbd\n\n![GitHub](https://img.shields.io/github/license/joshuar/gokbd)\n[![Go Reference](https://pkg.go.dev/badge/github.com/joshuar/gokbd.svg)](https://pkg.go.dev/github.com/joshuar/gokbd)\n[![gokbd](https://goreportcard.com/badge/github.com/joshuar/gokbd?style=flat-square)](https://goreportcard.com/report/github.com/joshuar/gokbd)\n[![codecov](https://codecov.io/gh/joshuar/gokbd/branch/main/graph/badge.svg?token=2BDVOTORZB)](https://codecov.io/gh/joshuar/gokbd)\n\n## About\n\ngokbd is a package that uses\n[libevdev](https://www.freedesktop.org/wiki/Software/libevdev/) to talk to a\nkeyboard on Linux. It allows snooping the keys pressed as well as typing out\nkeys.\n\n## Usage\n\n```go\nimport gokbd \"github.com/joshuar/gokbd\"\n```\n\nExamples for reading what keys are being typed (snooping) and writing to a\nvirtual keyboard are available under the `examples/` directory. To run them:\n\n```shell\ncd examples/snoop\ngo build\nsudo setcap cap_setgid,cap_setuid=p ./snoop\n./snoop\n\ncd examples/type\ngo build\nsudo setcap cap_setgid,cap_setuid=p ./type\n./type\n```\n\n## Permissions\n\nYou may need to grant additional permissions to the user running any program\nusing `gokbd`.\n\n- To read (snoop) from keyboards, the user will need to be part of the `input`\n  group. Typically, the user can be added with the following command:\n\n```shell\nsudo gpasswd -a $USER input\n```\n\n- To create a virtual keyboard and write to it, the user will need access to the\n  [kernel uinput\n  device](https://kernel.org/doc/html/latest/input/uinput.html). Typically, this\n  can be granted with a [udev rule](https://opensource.com/article/18/11/udev)\n  like the following:\n\n```shell\necho KERNEL==\\\"uinput\\\", GROUP=\\\"$USER\\\", MODE:=\\\"0660\\\" | sudo tee /etc/udev/rules.d/99-$USER.rules\nsudo udevadm trigger\n```\n\nYou will also need to grant your compiled binary the `CAP_SETUID` and\n`CAP_SETGID` Linux capabilities. You can do this with:\n\n```shell\nsudo setcap cap_setgid,cap_setuid=p /path/to/binary\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuar%2Fgokbd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshuar%2Fgokbd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshuar%2Fgokbd/lists"}