{"id":15032282,"url":"https://github.com/a-kenji/tui-term","last_synced_at":"2025-05-16T03:04:15.540Z","repository":{"id":173715893,"uuid":"641963486","full_name":"a-kenji/tui-term","owner":"a-kenji","description":"A pseudoterminal widget library for ratatui","archived":false,"fork":false,"pushed_at":"2025-05-13T20:16:48.000Z","size":525,"stargazers_count":150,"open_issues_count":18,"forks_count":12,"subscribers_count":4,"default_branch":"development","last_synced_at":"2025-05-13T21:31:33.257Z","etag":null,"topics":["ratatui","rust","terminal","tui","widget"],"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/a-kenji.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","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":"2023-05-17T14:24:40.000Z","updated_at":"2025-05-13T20:16:45.000Z","dependencies_parsed_at":"2023-10-03T18:11:36.463Z","dependency_job_id":"afeb497b-f1cb-4b59-81cb-5beaeee7ce85","html_url":"https://github.com/a-kenji/tui-term","commit_stats":null,"previous_names":["a-kenji/tui-term"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-kenji%2Ftui-term","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-kenji%2Ftui-term/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-kenji%2Ftui-term/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-kenji%2Ftui-term/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-kenji","download_url":"https://codeload.github.com/a-kenji/tui-term/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254459088,"owners_count":22074605,"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":["ratatui","rust","terminal","tui","widget"],"created_at":"2024-09-24T20:17:55.202Z","updated_at":"2025-05-16T03:04:10.499Z","avatar_url":"https://github.com/a-kenji.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tui-term\n[![Crates](https://img.shields.io/crates/v/tui-term?style=flat-square)](https://crates.io/crates/tui-term)\n[![Documentation](https://img.shields.io/badge/tui_term-documentation-fc0060?style=flat-square)](https://docs.rs/tui-term)\n[![Matrix Chat Room](https://img.shields.io/badge/chat-on%20matrix-1d7e64?logo=matrix\u0026style=flat-square)](https://matrix.to/#/#tui-term-main:matrix.org)\n\nA pseudoterminal widget for the  [ratatui](https://github.com/tui-rs-revival/ratatui) crate.\n\n![Demo of tui-term](https://vhs.charm.sh/vhs-4zK1zlTOSueAmlOkZlssBr.gif)\n\n## Status\n\n\u003e [!NOTE]\n\u003e This project is currently in active development and should be considered a work in progress.\n\u003e The goal of tui-term is to provide a robust and well-tested pseudoterminal widget for users of the `ratatui` crate.\n\n## Installation\n\nTo use `tui-term`, simply add it as a dependency in your `Cargo.toml` file:\n\n```sh\n[dependencies]\ntui-term = \"0.2.0\"\n```\nor use `cargo add`:\n```sh\ncargo add tui-term\n```\n\n## Examples\n\nCheck out the examples directory, for more information, or run an example:\n```sh\ncargo run --example simple_ls_rw\n```\n\n\n## Controller\n\nThe controller is an `experimental` feature helping with managing the lifecycle of commands that are spawned inside a pseudoterminal.\nCurrently the support is limited to oneshot commands.\n\nTo activate the feature:\n```sh\ncargo add tui-term -F unstable\n```\n\n## Chat Room\nJoin our [matrix chat room](https://matrix.to/#/#tui-term-main:matrix.org), for possibly synchronous communication.\n\n## Architecture\n\nFor an overview of `tui-term`'s architecture and design principles, please refer to the [Architecture](docs/ARCHITECTURE.md) documentation.\n\n## Contributing\nWe welcome contributions from the community!\nCheck out the [Contributing Guidelines](./docs/CONTRIBUTING.md) on how to get started.\n\n## Release Notes\nStay updated with the latest changes by viewing the [Changelog](./CHANGELOG.md).\n\n## License\n`tui-term` is available under the MIT license. See [LICENCE](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-kenji%2Ftui-term","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-kenji%2Ftui-term","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-kenji%2Ftui-term/lists"}