{"id":13726703,"url":"https://github.com/revery-ui/revery-terminal","last_synced_at":"2025-06-16T10:40:31.436Z","repository":{"id":52181441,"uuid":"240804634","full_name":"revery-ui/revery-terminal","owner":"revery-ui","description":"Barebones terminal emulator built with ReasonML + Revery + libvterm","archived":false,"fork":false,"pushed_at":"2021-05-06T00:23:01.000Z","size":703,"stargazers_count":81,"open_issues_count":2,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-12T13:07:29.404Z","etag":null,"topics":["libvterm","pty","reason","reason-native","reasonml","revery","terminal"],"latest_commit_sha":null,"homepage":"","language":"Reason","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/revery-ui.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}},"created_at":"2020-02-15T23:50:25.000Z","updated_at":"2024-01-03T14:16:52.000Z","dependencies_parsed_at":"2022-08-24T01:21:00.155Z","dependency_job_id":null,"html_url":"https://github.com/revery-ui/revery-terminal","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-terminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-terminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-terminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-terminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revery-ui","download_url":"https://codeload.github.com/revery-ui/revery-terminal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241418358,"owners_count":19959736,"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":["libvterm","pty","reason","reason-native","reasonml","revery","terminal"],"created_at":"2024-08-03T01:03:17.162Z","updated_at":"2025-03-01T20:17:14.850Z","avatar_url":"https://github.com/revery-ui.png","language":"Reason","funding_links":[],"categories":["Reason"],"sub_categories":[],"readme":"# revery-terminal\n\n[![Build Status](https://dev.azure.com/revery-ui/revery/_apis/build/status/revery-ui.revery-terminal?branchName=master)](https://dev.azure.com/revery-ui/revery/_build/latest?definitionId=25\u0026branchName=master)\n\nA terminal emulator built with Revery.\n\nThis is a barebones terminal emulator factored out from the work to include a terminal emulator in [Onivim 2](https://github.com/onivim/oni2).\n\nIt's also a fun exploration in leveraging an Elm-style architecture in a natively compiled application.\n\n![image](https://user-images.githubusercontent.com/13532591/74748975-3fbbf300-521e-11ea-8583-9ae1d4a18c35.png)\n\n## Pre-requisites\n\n- Make sure to install the [dependencies needed for Revery](https://github.com/microsoft/node-pty)\n- __OSX:__ You'll also need `glibtool` (`brew install libtool`)\n\n## Building\n\n- `npm install -g esy@0.6.2`\n- `esy install`\n- `esy build`\n\n## Running\n\n- `esy run`\n\n## Limitations\n\nThis is just meant as an exploration, and isn't production-ready. In particular, there are some pieces missing:\n\n- No Unicode support at the moment - assumes ASCII rendering\n- No ligatures or text shaping\n- No Windows support at the moment - we use the `openpty` API which is not available on Windows\n- Minimal keys are handled\n\nThese would all be great contribution opportunities, though!\n\n## Source Overview\n\n### Main modules\n\n- [`src/bin/App.re`](src/bin/App.re) - this is the entry point for the application (where we start the window, wire up our store).\n- [`src/bin/Model.re`](src/bin/Model.re) - this is the heart of our application - that provides the definition of `Model.t` as well as how it changes over time (by providing an `updater` function).\n\n### Supporting modules\n\n- [`src/lib/ReveryTerminal.rei`](src/lib/ReveryTerminal.rei) - contains cross-platform utilities for working with a terminal.\n- [`src/pty`](src/pty) - small OCaml binding to the `openpty` system call, to create a pseudoterminal.\n\n## Technologies Used\n\n- [Revery](https://github.com/revery-ui/revery) to provide the window management and drawing functionality.\n- [reason-libvterm](https://github.com/revery-ui/reason-libvterm) bindings for [libvterm](http://www.leonerd.org.uk/code/libvterm)\n- [isolinear](https://github.com/bryphe/isolinear) as an Elm-like applicatiion management framework.\n\nWe also use the [JetBrains Mono](https://www.jetbrains.com/lp/mono/) font.\n\n## License\n\nMIT\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-terminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevery-ui%2Frevery-terminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-terminal/lists"}