{"id":13595173,"url":"https://github.com/lemunozm/termchat","last_synced_at":"2025-05-16T02:09:57.961Z","repository":{"id":39668667,"uuid":"288302039","full_name":"lemunozm/termchat","owner":"lemunozm","description":"Terminal chat through the LAN with video streaming and file transfer.","archived":false,"fork":false,"pushed_at":"2023-11-27T18:02:35.000Z","size":190,"stargazers_count":575,"open_issues_count":7,"forks_count":25,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-12T16:06:01.779Z","etag":null,"topics":["chat","command-line-tool","lan","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lemunozm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2020-08-17T22:46:56.000Z","updated_at":"2025-04-28T04:37:06.000Z","dependencies_parsed_at":"2024-01-16T22:18:50.810Z","dependency_job_id":"9cc34e34-3fce-4678-9d36-1a452f1bff2c","html_url":"https://github.com/lemunozm/termchat","commit_stats":{"total_commits":70,"total_committers":5,"mean_commits":14.0,"dds":0.3285714285714286,"last_synced_commit":"53601128dc170ea2a88a9a184369278d177d6cd5"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemunozm%2Ftermchat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemunozm%2Ftermchat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemunozm%2Ftermchat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lemunozm%2Ftermchat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lemunozm","download_url":"https://codeload.github.com/lemunozm/termchat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254453667,"owners_count":22073618,"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":["chat","command-line-tool","lan","terminal"],"created_at":"2024-08-01T16:01:45.296Z","updated_at":"2025-05-16T02:09:57.821Z","avatar_url":"https://github.com/lemunozm.png","language":"Rust","funding_links":[],"categories":["Rust","💻 Apps"],"sub_categories":["🤡 Social Media"],"readme":"[![](https://img.shields.io/crates/v/termchat)](https://crates.io/crates/termchat)\n[![](https://img.shields.io/crates/l/termchat)](https://www.apache.org/licenses/LICENSE-2.0.txt)\n[![](https://img.shields.io/github/workflow/status/lemunozm/termchat/termchat%20ci)](https://github.com/lemunozm/termchat/actions?query=workflow%3A%22termchat+ci%22)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://docs.google.com/drawings/d/e/2PACX-1vTCUOY5x1FQ-zWJdagKPLVWLTWDO3QCg9brYPOHZ6qqK6LndPTDM3sfp0599w1F4VatZfLITTZM33JW/pub?w=712\u0026h=164\"/\u003e\n\u003c/p\u003e\n\nA distributed LAN chat application in the terminal (without needing a server!).\nRun the application in your terminal and write into the LAN!\n\nBuilt on top of [tui-rs](https://github.com/fdehau/tui-rs) to create the terminal UI and\n[message-io](https://github.com/lemunozm/message-io) to make the network connections.\n\n![](./screenshot.png)\n\n# Installation\nYou can use the [cargo][cargo] package manager in order to install it.\n\n```\n$ cargo install termchat --all-features\n```\n\nIf you have `~/.cargo/bin` in your PATH (or similar in your OS), you will be able to use *termchat* everywhere in your computer!\n\nAlso, you can download the last release for your machine from the [releases](https://github.com/lemunozm/termchat/releases).\n\n## Arch Linux\n\n`termchat` can be installed from available [AUR packages](https://aur.archlinux.org/packages/?O=0\u0026SeB=b\u0026K=termchat\u0026outdated=\u0026SB=n\u0026SO=a\u0026PP=50\u0026do_Search=Go) using an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers). For example,\n\n```sh\n$ yay -S termchat\n```\n\nIf you prefer, you can clone the [AUR packages](https://aur.archlinux.org/packages/?O=0\u0026SeB=b\u0026K=termchat\u0026outdated=\u0026SB=n\u0026SO=a\u0026PP=50\u0026do_Search=Go) and then compile them with [makepkg](https://wiki.archlinux.org/index.php/Makepkg). For example,\n\n```sh\n$ git clone https://aur.archlinux.org/termchat.git \u0026\u0026 cd termchat \u0026\u0026 makepkg -si\n```\n\n[cargo]: https://doc.rust-lang.org/cargo/getting-started/installation.html\n\n# How it works?\nTo not saturate the network, *termchat* uses only one multicast message at startup to find other *termchat* applications on the network.\nOnce a new application has been found by multicast, a TCP connection is created between them.\n\n## Usage\nSimply write:\n```\n$ termchat\n```\n\nto open the application in your terminal.\n\nBy default, your computer user name is used. You can use a different username with `-u \u003cname\u003e`\n\nYou can modify the multicast discovery address with `-d \u003caddress\u003e`\n\nYou can set a custom tcp sever port with `-t \u003cport\u003e`\n\n(see the application help for more info `--help`).\n\n### Commands\nTermchat treats messages containings the following commands in a special way:\n\n- **`?send \u003c$path_to_file\u003e`**: sends the specified file to everyone on the network,\n  example: `?send ./myfile`\n\n  Note: The received files can be found in `/tmp/termchat/\u003ctermchat-username\u003e/\u003cfile_name\u003e` on Linux or Mac,\n  or `%USERPROFILE%\\Appdata\\Local\\Temp\\termchat\\\u003ctermchat-username\u003e\\\u003cfile-name\u003e` if using Windows.\n\n- **`?startstream`**/**`?stopstream`**: starts/stops video stream and send it to all peers. Currently this is only supported on linux, the other platforms can only receive the video.\n\n### Config\nTermchat store its configuration in a simple file located at `$ConfigDir/termchat/config` in Mac or Linux,\nor `%USERPROFILE%\\AppData\\Roaming\\termchat\\config` if using Windows.\n\n**Default config:**\n```\ndiscovery_addr = \"238.255.0.1:5877\"\ntcp_server_port = 0\nuser_name = \"my_awesome_user_name\"\nterminal_bell = true\n\n[theme]\nmessage_colors = [\"Blue\", \"Yellow\", \"Cyan\", \"Magenta\"]\nmy_user_color = \"Green\"\ndate_color = \"DarkGray\"\nsystem_info_color = [\"Cyan\", \"LightCyan\"]\nsystem_warning_color = [\"Yellow\", \"LightYellow\"]\nsystem_error_color = [\"Red\", \"LightRed\"]\nchat_panel_color = \"White\"\nprogress_bar_color = \"LightGreen\"\ncommand_color = \"LightYellow\"\ninput_panel_color = \"White\"\n```\n\n## Frequently Asked Questions\n\n***Q:*** **Hosts are not disoverable**\n\n***A:***\n\n- Make sure that no firewall is running (example: ufw), and if that's the case either stop it or add termchat ports to the white list.\n\n- By default you need to allow port `5877/udp` and `port X/tcp`, `X` is a different with each run. Note that you can specify a custom tcp port as mentioned above and add it to the firewall whitelist.\n\n***Q:*** **Can I silence the terminal bell when I received a message?**\n\n***A:*** Yeah! You can run `termchat` passing the flag `--quiet-mode` or simple `-q`.\n\n***Q:*** **I can't see anything on my light themed desktop!!!**\n\n***A:*** You can use `termchat --theme light`, also you can customize colors individually via the config file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flemunozm%2Ftermchat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flemunozm%2Ftermchat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flemunozm%2Ftermchat/lists"}