{"id":25611467,"url":"https://github.com/sealbro/pikvm-automator","last_synced_at":"2026-05-13T20:31:59.735Z","repository":{"id":269047906,"uuid":"835263490","full_name":"sealbro/pikvm-automator","owner":"sealbro","description":"Simple API with short macro commands to automate PiKVM input emulation","archived":false,"fork":false,"pushed_at":"2024-12-20T14:15:37.000Z","size":297,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-21T23:20:17.200Z","etag":null,"topics":["automation","golang","grpc","macro","pikvm"],"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/sealbro.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,"publiccode":null,"codemeta":null}},"created_at":"2024-07-29T13:34:15.000Z","updated_at":"2024-12-20T14:24:40.000Z","dependencies_parsed_at":"2024-12-20T15:24:25.615Z","dependency_job_id":"8a16d397-0d14-4884-87b1-48faa080d72c","html_url":"https://github.com/sealbro/pikvm-automator","commit_stats":null,"previous_names":["sealbro/pikvm-automator"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/sealbro/pikvm-automator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sealbro%2Fpikvm-automator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sealbro%2Fpikvm-automator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sealbro%2Fpikvm-automator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sealbro%2Fpikvm-automator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sealbro","download_url":"https://codeload.github.com/sealbro/pikvm-automator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sealbro%2Fpikvm-automator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32999213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"ssl_error","status_checked_at":"2026-05-13T13:14:51.610Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["automation","golang","grpc","macro","pikvm"],"created_at":"2025-02-21T23:19:45.040Z","updated_at":"2026-05-13T20:31:59.719Z","avatar_url":"https://github.com/sealbro.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pikvm-automator\n\nAPI processor for simple and short macro instruction to automate PiKVM keyboard and mouse emulation.\nThe easiest way to store and send input commands to PiKVM device.\n\n[![Hub](https://badgen.net/docker/pulls/sealbro/pikvm-automator?icon=docker\u0026label=pikvm-automator)](https://hub.docker.com/r/sealbro/pikvm-automator/)\n\n```mermaid\nflowchart LR\n  subgraph Requests\n    direction RL\n    grpc(\"`gRPC`\")\n    openapi(\"`OpenAPI v3`\")\n  end\n  subgraph PiKVM\n    direction TB\n        subgraph pikvm-api\n        direction RL\n        api1(\"`wss (websocket)`\")\n        api2(\"`unix socket (kvmd.sock)`\")\n    end\n    subgraph Docker\n        pikvm-automator(\"`pikvm-automator`\")\n    end\n  end\n  subgraph Device\n    direction RL\n    sub1(\"`Keyboard`\")\n    sub2(\"`Mouse`\")\n  end\n  Requests -- macro --\u003e Docker --\u003e pikvm-api -- emulation --\u003e Device\n```\n\n## How to use\n\nRun in container and connect to remote PiKVM device with default credentials:\n\n```shell\ndocker run -it --rm \\\n -v $(pwd):/commands.yml \\\n -e PIKVM_ADDRESS=\u003cIP:PORT or HOST\u003e \\\n -e PIKVM_SOURCE=wss \\\n -e PIKVM_SKIP_TLS_VERIFY=true \\\n sealbro/pikvm-automator\n```\n\nRun in container on PiKVM device with default credentials:\n\n```shell\ndocker run -it --rm \\\n -v $(pwd):/commands.yml \\\n -v /run/kvmd:/run/kvmd \\\n -e PIKVM_ADDRESS=/run/kvmd/kvmd.sock \\\n -e PIKVM_SOURCE=unix \\\n -e PIKVM_SKIP_TLS_VERIFY=true \\\n sealbro/pikvm-automator\n```\n\n### API integration\n\n- [gRPC](./proto/pikvm_automator.proto)\n- [OpenAPI v3](./generated/openapiv3/openapi.yaml)\n- [API examples](./endpoints.http)\n\n### Environment variables\n\n| Name                    | Description                | Default         |\n|-------------------------|----------------------------|-----------------|\n| `PIKVM_ADDRESS`         | PiKVM api address          | required        |\n| `PIKVM_SOURCE`          | API source `wss` or `unix` | `wss`           |\n| `PIKVM_SKIP_TLS_VERIFY` | Skip TLS verify            | `false`         |\n| `PIKVM_USERNAME`        | PiKVM username             | `admin`         |\n| `PIKVM_PASSWORD`        | PiKVM password             | `admin`         |\n| `COMMANDS_PATH`         | Path with commands file    | `/commands.yml` |\n| `TEMPLATE_MAX_DEEP`     | Max recursive replacement  | `10`            |\n| `CALL_DEBOUNCE_SECONDS` | Next command cooldown      | `2`             |\n| `GRPC_PASSTHROUGH_AUTH` | Passthrough PiKVM auth     | `true`          |\n| `GRPC_PROTOCOL`         | gRPC protocol              | `tcp`           |\n| `GRPC_ADDRESS`          | gRPC endpoint              | `0.0.0.0:32023` |\n| `GRPC_GATEWAY_ADDRESS`  | openapi endpoint           | `0.0.0.0:8032`  |\n\n- `PIKVM_ADDRESS` is required\n  - `/run/kvmd/kvmd.sock` for unix socket on device\n  - `\u003cIP:PORT or HOST\u003e` for remote connection\n\n## Macro instruction\n\nExample of `commands.yml`:\n\n```yaml\nwin_d:\n  id: win_d\n  description: Collapse/Expand all windows\n  expression: MetaLeft+KeyD\nbios_enable_virtualization:\n  id: bios_enable_virtualization\n  description: Bios enable virtualization\n  expression: '@850''190|@left|700ms|@350''650|@left|700ms|@850''420|@left|300ms|End|50ms|Enter'\nbios_save_exit:\n  id: bios_save_exit\n  description: Bios save configuration and exit\n  expression: F10|200ms|@850'770|@left\nproxmox_mode:\n  id: proxmox_mode\n  description: Proxmox bios mode\n  expression: 2s|F2|5s|%bios_enable_virtualization%|1s|%bios_save_exit%\n```\n\n- `id` - unique identifier\n- `description` - description of command\n- `expression` - sequence of key presses\n  - `F1` - press F1 key ([more keys](./pkg/pikvm/keyboard/key.go))\n  - `|` - splitter between commands\n  - `+` - press multiple keys at once\n    - example `MetaLeft+KeyD` for `Win+D`, hold `MetaLeft` and press `KeyD` and release both\n  - `@850'190` - move mouse to x=850, y=190\n  - `@left` - press left mouse button\n  - `700ms` or `42s` - delay 700ms or 42s\n  - `%command_id%` - execute another command, allowed use recursion but not more than `TEMPLATE_MAX_DEEP` times","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsealbro%2Fpikvm-automator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsealbro%2Fpikvm-automator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsealbro%2Fpikvm-automator/lists"}