{"id":20887937,"url":"https://github.com/canop/xterm-query","last_synced_at":"2025-05-12T19:34:03.698Z","repository":{"id":57672603,"uuid":"444200935","full_name":"Canop/xterm-query","owner":"Canop","description":"utility to query the terminal","archived":false,"fork":false,"pushed_at":"2025-03-21T15:02:14.000Z","size":27,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-11T07:05:29.335Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/Canop.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":"2022-01-03T21:12:31.000Z","updated_at":"2025-03-26T00:50:16.000Z","dependencies_parsed_at":"2024-07-25T16:26:41.192Z","dependency_job_id":"a2f687cb-0e12-4b3f-ad47-4bc46bce7e5c","html_url":"https://github.com/Canop/xterm-query","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"68133dccfadcc0e5c55d2bd063e547a3b451898d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canop%2Fxterm-query","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canop%2Fxterm-query/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canop%2Fxterm-query/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canop%2Fxterm-query/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Canop","download_url":"https://codeload.github.com/Canop/xterm-query/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253808634,"owners_count":21967568,"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-11-18T08:23:25.876Z","updated_at":"2025-05-12T19:34:03.453Z","avatar_url":"https://github.com/Canop.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![MIT][s2]][l2] [![Latest Version][s1]][l1] [![docs][s3]][l3] [![Chat on Miaou][s4]][l4]\n\n[s1]: https://img.shields.io/crates/v/xterm-query.svg\n[l1]: https://crates.io/crates/xterm-query\n\n[s2]: https://img.shields.io/badge/license-MIT-blue.svg\n[l2]: LICENSE\n\n[s3]: https://docs.rs/xterm-query/badge.svg\n[l3]: https://docs.rs/xterm-query/\n\n[s4]: https://miaou.dystroy.org/static/shields/room.svg\n[l4]: https://miaou.dystroy.org/3\n\n\nLow level library to query the terminal with a CSI sequence and get the result as a string.\n\nNotes:\n\n- the terminal must already be in raw mode\n- there's no Windows support (it should be possible with [WSAPoll](https://learn.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsapoll) but I don't have any Windows computer to test so a PR would be welcome)\n\nThe provided example in examples/kitty demonstrates querying the terminal to know whether the [Kitty graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/) is supported, and manages entering and leaving raw mode.\n\nIf you think you might use this crate but are unsure, don't hesitate to come to Miaou: [![s4]][s4]\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanop%2Fxterm-query","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcanop%2Fxterm-query","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanop%2Fxterm-query/lists"}