{"id":14259554,"url":"https://github.com/ratatui/ratatui","last_synced_at":"2025-12-26T12:52:34.045Z","repository":{"id":86362028,"uuid":"600886023","full_name":"ratatui/ratatui","owner":"ratatui","description":"A Rust crate for cooking up terminal user interfaces (TUIs) 👨‍🍳🐀 https://ratatui.rs","archived":false,"fork":false,"pushed_at":"2025-09-01T15:48:10.000Z","size":132500,"stargazers_count":14791,"open_issues_count":185,"forks_count":461,"subscribers_count":44,"default_branch":"main","last_synced_at":"2025-09-03T06:25:12.588Z","etag":null,"topics":["cli","ratatui","rust","terminal","terminal-user-interface","tui","widgets"],"latest_commit_sha":null,"homepage":"https://ratatui.rs","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/ratatui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"ratatui","open_collective":"ratatui"}},"created_at":"2023-02-12T21:56:20.000Z","updated_at":"2025-09-03T06:10:30.000Z","dependencies_parsed_at":"2023-10-25T22:26:43.823Z","dependency_job_id":"446c67e0-12e5-4fb5-9f13-47a94f67c948","html_url":"https://github.com/ratatui/ratatui","commit_stats":{"total_commits":1415,"total_committers":210,"mean_commits":6.738095238095238,"dds":0.7908127208480565,"last_synced_commit":"f1d0a1837564d69f00e4b5d9eb94cc001cd3a3a7"},"previous_names":["ratatui-org/ratatui","tui-rs-revival/ratatui","ratatui/ratatui"],"tags_count":154,"template":false,"template_full_name":null,"purl":"pkg:github/ratatui/ratatui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratatui%2Fratatui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratatui%2Fratatui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratatui%2Fratatui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratatui%2Fratatui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ratatui","download_url":"https://codeload.github.com/ratatui/ratatui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ratatui%2Fratatui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274074983,"owners_count":25218018,"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-09-07T02:00:09.463Z","response_time":67,"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":["cli","ratatui","rust","terminal","terminal-user-interface","tui","widgets"],"created_at":"2024-08-22T10:01:22.969Z","updated_at":"2025-12-26T12:52:34.007Z","avatar_url":"https://github.com/ratatui.png","language":"Rust","readme":"\u003cdetails\u003e\n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [Quickstart](#quickstart)\n- [Documentation](#documentation)\n- [Templates](#templates)\n- [Built with Ratatui](#built-with-ratatui)\n- [Alternatives](#alternatives)\n- [Contributing](#contributing)\n- [Acknowledgements](#acknowledgements)\n- [License](#license)\n\n\u003c/details\u003e\n\n![Release header](https://github.com/ratatui/ratatui/blob/b23480adfa9430697071c906c7ba4d4f9bd37a73/assets/release-header.png?raw=true)\n\n\u003cdiv align=\"center\"\u003e\n\n[![Crate Badge]][Crate] [![Repo Badge]][Repo] [![Docs Badge]][Docs] [![License Badge]][License]  \\\n[![CI Badge]][CI] [![Deps Badge]][Deps] [![Codecov Badge]][Codecov] [![Sponsors Badge]][Sponsors]  \\\n[Ratatui Website] · [Docs] · [Widget Examples] · [App Examples] · [Changelog]  \\\n[Breaking Changes] · [Contributing] · [Report a bug] · [Request a Feature]\n\n\u003c/div\u003e\n\n[Ratatui][Ratatui Website] (_ˌræ.təˈtu.i_) is a Rust crate for cooking up terminal user interfaces\n(TUIs). It provides a simple and flexible way to create text-based user interfaces in the terminal,\nwhich can be used for command-line applications, dashboards, and other interactive console programs.\n\n## Quickstart\n\nRatatui has [templates] available to help you get started quickly. You can use the\n[`cargo-generate`] command to create a new project with Ratatui:\n\n```shell\ncargo install --locked cargo-generate\ncargo generate ratatui/templates\n```\n\nSelecting the Hello World template produces the following application:\n\n```rust\nuse color_eyre::Result;\nuse crossterm::event::{self, Event};\nuse ratatui::{DefaultTerminal, Frame};\n\nfn main() -\u003e Result\u003c()\u003e {\n    color_eyre::install()?;\n    let terminal = ratatui::init();\n    let result = run(terminal);\n    ratatui::restore();\n    result\n}\n\nfn run(mut terminal: DefaultTerminal) -\u003e Result\u003c()\u003e {\n    loop {\n        terminal.draw(render)?;\n        if matches!(event::read()?, Event::Key(_)) {\n            break Ok(());\n        }\n    }\n}\n\nfn render(frame: \u0026mut Frame) {\n    frame.render_widget(\"hello world\", frame.area());\n}\n```\n\n## Documentation\n\n- [Docs] - the full API documentation for the library on docs.rs.\n- [Ratatui Website] - explains the library's concepts and provides step-by-step tutorials.\n- [Ratatui Forum] - a place to ask questions and discuss the library.\n- [Widget Examples] - a collection of examples that demonstrate how to use the library.\n- [App Examples] - a collection of more complex examples that demonstrate how to build apps.\n- [ARCHITECTURE.md] - explains the crate organization and modular workspace structure.\n- [Changelog] - generated by [git-cliff] utilizing [Conventional Commits].\n- [Breaking Changes] - a list of breaking changes in the library.\n\nYou can also watch the [EuroRust 2024 talk] to learn about common concepts in Ratatui and what's\npossible to build with it.\n\n## Templates\n\nIf you're looking to get started quickly, you can use one of the available templates from the\n[templates] repository using [`cargo-generate`]:\n\n```shell\ncargo generate ratatui/templates\n```\n\n## Built with Ratatui\n\n[![Awesome](https://awesome.re/badge-flat2.svg)][awesome-ratatui]\n\nCheck out the [showcase] section of the website, or the [awesome-ratatui] repository for a curated\nlist of awesome apps and libraries built with Ratatui!\n\n## Alternatives\n\n- [Cursive](https://crates.io/crates/cursive) - a ncurses-based TUI library.\n- [iocraft](https://crates.io/crates/iocraft) - a declarative TUI library.\n\n## Contributing\n\n[![Discord Badge]][Discord Server] [![Matrix Badge]][Matrix] [![Forum Badge]][Ratatui Forum]\n\nFeel free to join our [Discord server](https://discord.gg/pMCEU9hNEj) for discussions and questions!\nThere is also a [Matrix](https://matrix.org/) bridge available at\n[#ratatui:matrix.org](https://matrix.to/#/#ratatui:matrix.org). We have also recently launched the\n[Ratatui Forum].\n\nWe rely on GitHub for [bugs][Report a bug] and [feature requests][Request a Feature].\n\nPlease make sure you read the [contributing](./CONTRIBUTING.md) guidelines before [creating a pull\nrequest][Create a Pull Request]. We accept AI generated code, but please read the [AI Contributions]\nguidelines to ensure compliance.\n\nIf you'd like to show your support, you can add the Ratatui badge to your project's README:\n\n```md\n[![Built With Ratatui](https://img.shields.io/badge/Built_With_Ratatui-000?logo=ratatui\u0026logoColor=fff)](https://ratatui.rs/)\n```\n\n[![Built With Ratatui](https://img.shields.io/badge/Built_With_Ratatui-000?logo=ratatui\u0026logoColor=fff)](https://ratatui.rs/)\n\n## Acknowledgements\n\nRatatui was forked from the [tui-rs] crate in 2023 in order to continue its development. None of\nthis could be possible without [Florian Dehau] who originally created [tui-rs] which inspired many\nRust TUIs.\n\nSpecial thanks to [Pavel Fomchenkov] for his work in designing an awesome logo for the Ratatui\nproject and organization.\n\n## License\n\nThis project is licensed under the [MIT License][License].\n\n[Repo]: https://github.com/ratatui/ratatui\n[Ratatui Website]: https://ratatui.rs/\n[Ratatui Forum]: https://forum.ratatui.rs\n[Docs]: https://docs.rs/ratatui\n[Widget Examples]: https://github.com/ratatui/ratatui/tree/main/ratatui-widgets/examples\n[App Examples]: https://github.com/ratatui/ratatui/tree/main/examples\n[ARCHITECTURE.md]: https://github.com/ratatui/ratatui/blob/main/ARCHITECTURE.md\n[Changelog]: https://github.com/ratatui/ratatui/blob/main/CHANGELOG.md\n[git-cliff]: https://git-cliff.org\n[Conventional Commits]: https://www.conventionalcommits.org\n[Breaking Changes]: https://github.com/ratatui/ratatui/blob/main/BREAKING-CHANGES.md\n[EuroRust 2024 talk]: https://www.youtube.com/watch?v=hWG51Mc1DlM\n[Report a bug]: https://github.com/ratatui/ratatui/issues/new?labels=bug\u0026projects=\u0026template=bug_report.md\n[Request a Feature]: https://github.com/ratatui/ratatui/issues/new?labels=enhancement\u0026projects=\u0026template=feature_request.md\n[Create a Pull Request]: https://github.com/ratatui/ratatui/compare\n[Contributing]: https://github.com/ratatui/ratatui/blob/main/CONTRIBUTING.md\n[AI Contributions]: https://github.com/ratatui/ratatui/blob/main/CONTRIBUTING.md#ai-generated-content\n[Crate]: https://crates.io/crates/ratatui\n[tui-rs]: https://crates.io/crates/tui\n[Sponsors]: https://github.com/sponsors/ratatui\n[Crate Badge]: https://img.shields.io/crates/v/ratatui?logo=rust\u0026style=flat-square\u0026color=E05D44\n[Repo Badge]: https://img.shields.io/badge/repo-ratatui/ratatui-1370D3?style=flat-square\u0026logo=github\n[License Badge]: https://img.shields.io/crates/l/ratatui?style=flat-square\u0026color=1370D3\n[CI Badge]: https://img.shields.io/github/actions/workflow/status/ratatui/ratatui/ci.yml?style=flat-square\u0026logo=github\n[CI]: https://github.com/ratatui/ratatui/actions/workflows/ci.yml\n[Codecov Badge]: https://img.shields.io/codecov/c/github/ratatui/ratatui?logo=codecov\u0026style=flat-square\u0026token=BAQ8SOKEST\u0026color=C43AC3\n[Codecov]: https://app.codecov.io/gh/ratatui/ratatui\n[Deps Badge]: https://deps.rs/repo/github/ratatui/ratatui/status.svg?path=ratatui\u0026style=flat-square\n[Deps]: https://deps.rs/repo/github/ratatui/ratatui?path=ratatui\n[Discord Badge]: https://img.shields.io/discord/1070692720437383208?label=discord\u0026logo=discord\u0026style=flat-square\u0026color=1370D3\u0026logoColor=1370D3\n[Discord Server]: https://discord.gg/pMCEU9hNEj\n[Docs Badge]: https://img.shields.io/badge/docs-ratatui-1370D3?style=flat-square\u0026logo=rust\n[Matrix Badge]: https://img.shields.io/matrix/ratatui-general%3Amatrix.org?style=flat-square\u0026logo=matrix\u0026label=Matrix\u0026color=C43AC3\n[Matrix]: https://matrix.to/#/#ratatui:matrix.org\n[Forum Badge]: https://img.shields.io/discourse/likes?server=https%3A%2F%2Fforum.ratatui.rs\u0026style=flat-square\u0026logo=discourse\u0026label=forum\u0026color=C43AC3\n[Sponsors Badge]: https://img.shields.io/github/sponsors/ratatui?logo=github\u0026style=flat-square\u0026color=1370D3\n[templates]: https://github.com/ratatui/templates/\n[showcase]: https://ratatui.rs/showcase/\n[awesome-ratatui]: https://github.com/ratatui/awesome-ratatui\n[Pavel Fomchenkov]: https://github.com/nawok\n[Florian Dehau]: https://github.com/fdehau\n[`cargo-generate`]: https://crates.io/crates/cargo-generate\n[License]: ./LICENSE\n","funding_links":["https://github.com/sponsors/ratatui","https://opencollective.com/ratatui"],"categories":["Rust","Programming","Libraries","cli","\u003ca name=\"Rust\"\u003e\u003c/a\u003eRust","Others","TUI Frameworks \u0026 Libraries","Program"],"sub_categories":["Rust 🦀","Command-line","Rust"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fratatui%2Fratatui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fratatui%2Fratatui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fratatui%2Fratatui/lists"}