{"id":30123424,"url":"https://github.com/nullstalgia/yap","last_synced_at":"2025-08-10T14:41:51.851Z","repository":{"id":308359351,"uuid":"921121605","full_name":"nullstalgia/yap","owner":"nullstalgia","description":"A friendly serial terminal application.","archived":false,"fork":false,"pushed_at":"2025-08-05T13:06:58.000Z","size":1227,"stargazers_count":4,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-05T15:08:43.088Z","etag":null,"topics":["defmt","esp32","macros","ratatui","rust","serial","serialport","tui","usb"],"latest_commit_sha":null,"homepage":"","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/nullstalgia.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,"zenodo":null}},"created_at":"2025-01-23T11:29:08.000Z","updated_at":"2025-08-05T13:46:22.000Z","dependencies_parsed_at":"2025-08-05T15:09:21.665Z","dependency_job_id":"4dfb90d8-ecc3-4d8e-b166-2e07d7fcfe58","html_url":"https://github.com/nullstalgia/yap","commit_stats":null,"previous_names":["nullstalgia/yap"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nullstalgia/yap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullstalgia%2Fyap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullstalgia%2Fyap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullstalgia%2Fyap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullstalgia%2Fyap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nullstalgia","download_url":"https://codeload.github.com/nullstalgia/yap/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullstalgia%2Fyap/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269738656,"owners_count":24467566,"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-08-10T02:00:08.965Z","response_time":71,"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":["defmt","esp32","macros","ratatui","rust","serial","serialport","tui","usb"],"created_at":"2025-08-10T14:41:51.311Z","updated_at":"2025-08-10T14:41:51.829Z","avatar_url":"https://github.com/nullstalgia.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yap - A friendly serial terminal.\n\n[![Build](https://github.com/nullstalgia/yap/actions/workflows/build.yml/badge.svg)](https://github.com/nullstalgia/yap/actions/workflows/build.yml) [![Release](https://github.com/nullstalgia/yap/actions/workflows/release.yml/badge.svg)](https://github.com/nullstalgia/yap/actions/workflows/release.yml)\n\n\u003cimg width=\"1080\" height=\"607\" alt=\"a split view of yap's port selection screen and port interaction screen\" src=\"https://github.com/user-attachments/assets/fa42e8e8-5481-4600-8c6f-532a4a86d4d9\" /\u003e\n\n### Features\n\n- User-friendly interface for interacting with Serial/COM ports.\n- Optional Pseudo-shell mode to allow preparing an input before sending, with history.\n- Intelligent auto-reconnect (checks for devices with matching characteristics, if port path changes unexpectedly).\n- Text can be colored by incoming ANSI commands, or by user-created color rules, supporting matching by either regex or string literals.\n- Connect to a device from the command line by supplying USB PID+VID\n- Log recieved port data to disk as UTF-8 processed text and/or raw bytes.\n- Macros with categories to organize commonly sent payloads.\n- Support for flashing connected ESP32 devices with .bin/.elf files!\n  - Powered by [esp-rs/espflash](https://github.com/esp-rs/espflash)!\n- Support for decoding incoming bytes as [defmt](https://github.com/knurling-rs/defmt) frames.\n- Configurable keybinds, including for Macros and ESP32 flashing!\n  - Keybinds can have several actions that run in order, so you can flash a device and send setup commands if it finishes successfully.\n- Hex view to see raw contents of incoming inputs.\n- Allow hiding specific devices from Port Selection screen.\n- Releases downloaded from GitHub can self-update!\n- Cross-Platform!\n\n# Showcase\n\n### Auto-Reconnection Example:\nhttps://github.com/user-attachments/assets/647d0172-3f79-4d47-974d-48f344adc645\n\n### espflash Flashing Example:\nhttps://github.com/user-attachments/assets/d14e6aa2-51d1-489f-b8ba-ca88f74ad3d2\n\n# Pre-compiled Downloads\n\nPre-compiled portable binaries can be found in [Releases](https://github.com/nullstalgia/yap/releases).\n\n`yap-full` builds have all optional features enabled!\n\n`yap-lite` builds exclude less universally-applicable features (currently excluded: `espflash`, `defmt`, `defmt_watch`).\n\n# Installation\n\nCrates.io releases are not yet available (due to some dependencies not being available/yet released to crates.io).\n\nLocal installation can be accomplished by running\n\n```\ncargo install --git https://github.com/nullstalgia/yap --no-default-features --features yap-full\n```\n\n(or `yap-lite` or any other combination of features).\n\nAvoid enabling the `self-replace` or `portable` features on installed builds!\n\n# Usage\n\nOpen port selection:\n\n```\nyap\n```\n\nTry to connect to port at `COM1`:\n\n```\nyap COM1\n```\n\nTry to connect to port at `COM1` with 9600 baudrate:\n\n```\nyap COM1 9600\n```\n\nTry to connect to found USB device with VID 303A and PID 1001:\n\n```\nyap 303A:1001\n```\n\nTry to connect to found USB device with VID 303A and PID 1001 and Serial Number 123456 with 9600 baudrate:\n\n```\nyap 303A:1001:123456 9600\n```\n\n## Antivirus notice:\n\nDownloaded Windows builds of `yap` may falsely trigger Windows Defender, likely due to the executable's capacity to self-update.\n\nRelease builds have GitHub Attestations enabled to help you to verify their authenticity!\n\n\n## Acknowledgements:\n\nInspired by the likes of [minicom](https://salsa.debian.org/minicom-team/minicom)/[picocom](https://github.com/npat-efault/picocom), [Termite](https://www.compuphase.com/software_termite.htm), [CuteCom](https://cutecom.sourceforge.net/), [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/), and others.\n\nThis wouldn't have been possible without the prior work of the original [`ansi-to-tui`](https://github.com/ratatui/ansi-to-tui) crate, [`esp-rs`'s team](https://github.com/esp-rs), [Ferrous Systems](https://ferrous-systems.com/), and many many other incredible crate authors and educators. Thank you all!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullstalgia%2Fyap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnullstalgia%2Fyap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullstalgia%2Fyap/lists"}