{"id":34819423,"url":"https://github.com/muhammedaksam/waha-tui","last_synced_at":"2026-01-12T15:26:45.252Z","repository":{"id":329334565,"uuid":"1118163078","full_name":"muhammedaksam/waha-tui","owner":"muhammedaksam","description":"A beautiful Terminal User Interface for WhatsApp using WAHA (WhatsApp HTTP API). Manage your WhatsApp sessions, chats, and messages directly from your terminal with an intuitive TUI powered by OpenTUI.","archived":false,"fork":false,"pushed_at":"2025-12-31T14:14:28.000Z","size":2736,"stargazers_count":225,"open_issues_count":0,"forks_count":5,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-04T08:48:59.773Z","etag":null,"topics":["chat","cli","messaging","opentui","terminal","tui","waha","whatsapp"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@muhammedaksam/waha-tui","language":"TypeScript","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/muhammedaksam.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":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-17T10:56:46.000Z","updated_at":"2026-01-04T04:08:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/muhammedaksam/waha-tui","commit_stats":null,"previous_names":["muhammedaksam/waha-tui"],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/muhammedaksam/waha-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammedaksam%2Fwaha-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammedaksam%2Fwaha-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammedaksam%2Fwaha-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammedaksam%2Fwaha-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muhammedaksam","download_url":"https://codeload.github.com/muhammedaksam/waha-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammedaksam%2Fwaha-tui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28340714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["chat","cli","messaging","opentui","terminal","tui","waha","whatsapp"],"created_at":"2025-12-25T14:08:27.491Z","updated_at":"2026-01-12T15:26:45.247Z","avatar_url":"https://github.com/muhammedaksam.png","language":"TypeScript","funding_links":[],"categories":["Developer Tools"],"sub_categories":[],"readme":"# WAHA TUI\n\n\u003e **WhatsApp in your terminal.**\n\n[![npm version](https://img.shields.io/npm/v/@muhammedaksam/waha-tui.svg)](https://www.npmjs.com/package/@muhammedaksam/waha-tui)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)\n[![Bun](https://img.shields.io/badge/Bun-000?logo=bun\u0026logoColor=fff)](https://bun.sh/)\n[![CI](https://github.com/muhammedaksam/waha-tui/workflows/CI/badge.svg)](https://github.com/muhammedaksam/waha-tui/actions)\n\n\u003e ⚠️ **Work In Progress** - This project is in early experimental development. Features may be incomplete, unstable, or change without notice.\n\nA beautiful Terminal User Interface for WhatsApp using [WAHA (WhatsApp HTTP API)](https://github.com/devlikeapro/waha). Manage your WhatsApp sessions, chats, and messages directly from your terminal with an intuitive TUI powered by [OpenTUI](https://opentui.com).\n\n\u003cp align=\"center\"\u003e\n  \u003cvideo src=\"https://github.com/user-attachments/assets/151a3ce4-fbf2-477a-83e7-3bc77e59a980\" width=\"90%\" autoplay loop muted\u003e\u003c/video\u003e\n\u003c/p\u003e\n\n## Features\n\n- 📱 **Session Management** - Create, view, and manage WAHA sessions with QR code or phone number pairing\n- 💬 **Chat Interface** - Browse chats with WhatsApp-style layout and real-time updates\n- ✉️ **Messaging** - Send and receive messages with read receipts\n- 🎨 **Beautiful UI** - WhatsApp Web-inspired interface with colors and icons\n- ⚡ **Fast \u0026 Lightweight** - Built with Bun for blazing-fast performance\n- 🔒 **Secure** - All configuration stored locally in `$XDG_CONFIG_HOME/waha-tui/`\n- 🔄 **Auto-Refresh** - QR codes refresh automatically, status updates in real-time\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/media/images/01-configuration.png\" width=\"45%\" alt=\"Configuration\" /\u003e\n  \u003cimg src=\".github/media/images/02-connect.png\" width=\"45%\" alt=\"Connect\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/media/images/03-qr-code-login.png\" width=\"45%\" alt=\"QR Code Login\" /\u003e\n  \u003cimg src=\".github/media/images/04-loading.png\" width=\"45%\" alt=\"Loading\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/media/images/05-main-screen.png\" width=\"45%\" alt=\"Main Screen\" /\u003e\n  \u003cimg src=\".github/media/images/06-conversation-view.png\" width=\"45%\" alt=\"Conversation View\" /\u003e\n\u003c/p\u003e\n\n## Quick Start\n\n### Run directly with bunx (no installation required)\n\n```bash\nbunx @muhammedaksam/waha-tui\n```\n\n### Or install globally\n\n```bash\nbun add -g @muhammedaksam/waha-tui\nwaha-tui\n```\n\n### Or clone and run locally\n\n```bash\ngit clone https://github.com/muhammedaksam/waha-tui.git\ncd waha-tui\nbun install\nbun dev\n```\n\n## Prerequisites\n\n- [Bun](https://bun.sh) \u003e= 1.0\n- A running [WAHA server](https://github.com/devlikeapro/waha)\n\n### WEBJS Engine Configuration\n\nIf you're using the **WEBJS** engine (default for WAHA CORE), you must enable `tagsEventsOn` in your session config to receive typing indicators (`presence.update`) and message ack events:\n\n```json\n{\n  \"name\": \"default\",\n  \"config\": {\n    \"webjs\": {\n      \"tagsEventsOn\": true\n    }\n  }\n}\n```\n\n\u003e **Note**: This setting is required for real-time typing indicators to work. See [WAHA documentation](https://waha.devlike.pro/docs/how-to/sessions/#webjs) for more details.\n\n## Configuration\n\nOn first run, WAHA TUI will prompt you for configuration with a beautiful setup wizard.\n\nConfiguration is stored in `$XDG_CONFIG_HOME/waha-tui/` (defaults to `~/.config/waha-tui/`) with secrets separated from metadata:\n\n### $XDG_CONFIG_HOME/waha-tui/.env (Secrets)\n\n```env\n# WAHA TUI Configuration\n# Connection settings for WAHA server\n\nWAHA_URL=http://localhost:3000\nWAHA_API_KEY=your-api-key-here\n```\n\n### $XDG_CONFIG_HOME/waha-tui/config.json (Metadata)\n\n```json\n{\n  \"version\": \"1.0.0\",\n  \"createdAt\": \"2024-12-19T00:00:00.000Z\",\n  \"updatedAt\": \"2024-12-19T00:00:00.000Z\"\n}\n```\n\n### Development: Project .env\n\nFor development, you can also create a `.env` in the project root which takes precedence:\n\n```env\nWAHA_URL=http://localhost:3000\nWAHA_API_KEY=your-api-key-here\n```\n\n## Usage\n\n### Keyboard Shortcuts\n\n| Key      | Action                                        |\n| -------- | --------------------------------------------- |\n| `↑/↓`    | Navigate lists                                |\n| `Enter`  | Select item / Open chat / Submit phone number |\n| `Esc`    | Go back / Cancel phone pairing                |\n| `i`      | Enter input mode (in conversation)            |\n| `r`      | Refresh current view                          |\n| `n`      | Create new session (in Sessions view)         |\n| `p`      | Switch to phone pairing mode (in QR view)     |\n| `1`      | Go to Sessions view                           |\n| `2`      | Go to Chats view                              |\n| `q`      | Quit / Go back / Switch to QR mode            |\n| `Ctrl+C` | Exit immediately                              |\n\n### Debug Logging\n\nEnable debug logging to troubleshoot issues:\n\n```bash\n# Via environment variable\nWAHA_TUI_DEBUG=1 bun dev\n\n# Via command-line flag\nbun dev --debug\n```\n\nDebug logs are saved to `$XDG_CONFIG_HOME/waha-tui/debug.log` with automatic sanitization of sensitive data.\n\n## Development\n\nSee [DEVELOPMENT.md](DEVELOPMENT.md) for development setup, commands, and project structure.\n\n## Technologies\n\n- **Runtime**: [Bun](https://bun.sh)\n- **UI Framework**: [OpenTUI](https://opentui.com)\n- **WAHA SDK**: [@muhammedaksam/waha-node](https://www.npmjs.com/package/@muhammedaksam/waha-node)\n- **TypeScript**: Type-safe development\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.\n\n## Security\n\nSee [SECURITY.md](SECURITY.md) for security policy and reporting vulnerabilities.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Related Projects\n\n- [WAHA HTTP API](https://github.com/devlikeapro/waha) - WhatsApp HTTP API\n- [WAHA Node SDK](https://github.com/muhammedaksam/waha-node) - TypeScript SDK for WAHA\n- [OpenTUI](https://opentui.com) - Terminal UI framework used by waha-tui\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammedaksam%2Fwaha-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuhammedaksam%2Fwaha-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammedaksam%2Fwaha-tui/lists"}