{"id":31923088,"url":"https://github.com/rocketchat/rocketchat-tui","last_synced_at":"2025-10-13T23:44:03.612Z","repository":{"id":46144241,"uuid":"501426635","full_name":"RocketChat/rocketchat-tui","owner":"RocketChat","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-06T20:03:56.000Z","size":109,"stargazers_count":9,"open_issues_count":6,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-05-01T11:29:38.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RocketChat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-08T22:14:58.000Z","updated_at":"2024-01-03T15:15:16.000Z","dependencies_parsed_at":"2022-08-12T12:40:46.035Z","dependency_job_id":null,"html_url":"https://github.com/RocketChat/rocketchat-tui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RocketChat/rocketchat-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RocketChat","download_url":"https://codeload.github.com/RocketChat/rocketchat-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-tui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017231,"owners_count":26086016,"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-10-13T02:00:06.723Z","response_time":61,"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":[],"created_at":"2025-10-13T23:43:56.999Z","updated_at":"2025-10-13T23:44:03.605Z","avatar_url":"https://github.com/RocketChat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rocket.Chat Terminal User Interface\n\nTerminal User Interface for [Rocket.Chat](https://github.com/RocketChat) made using [Bubbletea](https://github.com/charmbracelet/bubbletea)\n\n### Quick Start\n\nPrerequisites:\n\n- [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git)\n- [Golang](https://go.dev/)\n\n## Development\n- Clone this Project Repo and set up [Rocket.chat Meteor Application](https://github.com/RocketChat/Rocket.Chat) in your machine.\n- Run Rocketchat Meteor Server on your `http://localhost:3000` and login/signup into a new account save your credentials for signing in TUI.\n- In the RocketChat TUI root folder run `go get` in terminal to get all golang packages we are using\n- Make a `.env` file in the project root directory and add below code in it.\n\n    ```\n    PROD_SERVER_URL=https://community.liaison.rocketchat.digital\n    DEV_SERVER_URL=http://localhost:3000\n    ```\n- Now in the RocketChat TUI root folder run `go run main.go -debug` to run the TUI.\n- We have to pass `-debug` flag so that it logs log statements in `debug.log` file.\n- To use production server pass `-prod` flag too while running `main.go`. It will use the production server.\n- To use any other server pass `-url` flag too while running `main.go` i.e. `go run main.go -url=https://open.rocket.chat`. It will use the given server.\n- Hopefully you will see the TUI running.\n- Enter your email and password. Press Enter to login.\n\n## Structure of the Project\n- The starting file of the project is `main.go`. It starts the bubbletea Program to run TUI.\n- TUI models, view and controllers are present in ui folder.\n- In ui folder `model.go` contain global state of TUI and methods required by bubbletea to initialise, Update and Render the TUI in terminal.\n- In ui folder `view.go` contain UI code of the TUI which uses styles defined in `styles` package. We are using [lipgloss](https://github.com/charmbracelet/lipgloss) for styling the TUI.\n- All Key bindings used in TUI is present in `keyBindings` package to keep them seperate from TUI so that new key bindings can be easily added when needed.\n- Caching related functions are present in `cache` package","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frocketchat-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frocketchat%2Frocketchat-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frocketchat-tui/lists"}