{"id":19938167,"url":"https://github.com/2kabhishek/tmux2k","last_synced_at":"2025-04-12T16:35:04.532Z","repository":{"id":59024411,"uuid":"522734575","full_name":"2KAbhishek/tmux2k","owner":"2KAbhishek","description":"Make tmux powerful and pretty 🥊💅","archived":false,"fork":false,"pushed_at":"2025-03-31T06:35:03.000Z","size":2238,"stargazers_count":250,"open_issues_count":0,"forks_count":29,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-03T19:12:26.541Z","etag":null,"topics":["cli","plugin","powerline","pretty","tmux","tools","tpm","utility"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/2KAbhishek.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"2kabhishek","buy_me_a_coffee":"2kabhishek"}},"created_at":"2022-08-08T23:11:15.000Z","updated_at":"2025-04-03T10:30:23.000Z","dependencies_parsed_at":"2024-07-29T14:48:03.025Z","dependency_job_id":"c6b52ead-3e1c-4c16-828a-af409f3ba212","html_url":"https://github.com/2KAbhishek/tmux2k","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"2KAbhishek/bare-minimum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2KAbhishek%2Ftmux2k","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2KAbhishek%2Ftmux2k/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2KAbhishek%2Ftmux2k/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2KAbhishek%2Ftmux2k/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2KAbhishek","download_url":"https://codeload.github.com/2KAbhishek/tmux2k/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248597047,"owners_count":21130798,"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":["cli","plugin","powerline","pretty","tmux","tools","tpm","utility"],"created_at":"2024-11-12T23:38:36.286Z","updated_at":"2025-04-12T16:35:04.501Z","avatar_url":"https://github.com/2KAbhishek.png","language":"Shell","funding_links":["https://github.com/sponsors/2kabhishek","https://buymeacoffee.com/2kabhishek"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align = \"center\"\u003e\n\n\u003ch1\u003e\u003ca href=\"https://2kabhishek.github.io/tmux2k\"\u003etmux2k\u003c/a\u003e\u003c/h1\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/blob/main/LICENSE\"\u003e\n\u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/2kabhishek/tmux2k?style=flat\u0026color=eee\u0026label=\"\u003e \u003c/a\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/graphs/contributors\"\u003e\n\u003cimg alt=\"People\" src=\"https://img.shields.io/github/contributors/2kabhishek/tmux2k?style=flat\u0026color=ffaaf2\u0026label=People\"\u003e \u003c/a\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/stargazers\"\u003e\n\u003cimg alt=\"Stars\" src=\"https://img.shields.io/github/stars/2kabhishek/tmux2k?style=flat\u0026color=98c379\u0026label=Stars\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/network/members\"\u003e\n\u003cimg alt=\"Forks\" src=\"https://img.shields.io/github/forks/2kabhishek/tmux2k?style=flat\u0026color=66a8e0\u0026label=Forks\"\u003e \u003c/a\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/watchers\"\u003e\n\u003cimg alt=\"Watches\" src=\"https://img.shields.io/github/watchers/2kabhishek/tmux2k?style=flat\u0026color=f5d08b\u0026label=Watches\"\u003e \u003c/a\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k/pulse\"\u003e\n\u003cimg alt=\"Last Updated\" src=\"https://img.shields.io/github/last-commit/2kabhishek/tmux2k?style=flat\u0026color=e06c75\u0026label=\"\u003e \u003c/a\u003e\n\n\u003ch3\u003eMake tmux powerful and pretty 🥊💅\u003c/h3\u003e\n\n\u003c/div\u003e\n\ntmux2k is a highly customizable framework designed to enhance your tmux status bar, providing you with a sleek and informative interface for your terminal sessions.\n\n![default-plugins](./images/default-plugins.png)\n\n## ✨ Features\n\n- **Informative Display**: Essential system stats, git info, weather, and more.\n- **Plugin Ecosystem**: Extensive plugins for system monitoring and version control.\n- **Easy Customization**: Intuitive configuration and flexible architecture.\n- **Real-Time Updates**: Dynamic content rendering for a responsive experience.\n\n## ⚡ Setup\n\n### ⚙️ Requirements\n\n\u003e [!IMPORTANT]\n\u003e bash 5.2 or newer, macOS users can install it using `brew install bash`\n\n- A [patched nerd font](https://www.nerdfonts.com/) for `powerline` and glyphs support.\n\n### 💻 Installation\n\nIf you are a `tpm` user, you can install the theme and keep up to date by adding the following to your `.tmux.conf` file:\n\n```bash\nset -g @plugin '2kabhishek/tmux2k'\n```\n\nRun tmux and use the tpm install command: `prefix + I` (default prefix is `ctrl+b`)\n\nYou can also directly clone the repo to your `~/.tmux/plugins/` folder.\n\n### 🎨 Available Themes:\n\n- default ![default](./images/default.png)\n- default icons ![default-icons](./images/default-icons.png)\n- catppuccin ![catppuccin](./images/catppuccin.png)\n- catppuccin icons ![catppuccin-icons](./images/catppuccin-icons.png)\n- gruvbox ![gruvbox](./images/gruvbox.png)\n- gruvbox icons ![gruvbox-icons](./images/gruvbox-icons.png)\n- monokai ![monokai](./images/monokai.png)\n- monokai icons ![monokai-icons](./images/monokai-icons.png)\n- onedark ![onedark](./images/onedark.png)\n- onedark icons ![onedark-icons](./images/onedark-icons.png)\n- duo ![duo](./images/duo.png)\n- duo icons ![duo-icons](./images/duo-icons.png)\n- duo blue ![duo-blue](./images/duo-blue.png)\n- default no powerline ![default-no-powerline](./images/default-no-powerline.png)\n\nTo use themes:\n\n```bash\n# use a theme\nset -g @tmux2k-theme 'onedark'\n\n# to show icons only\nset -g @tmux2k-icons-only true\n\n# to customize duo bg and fg\nset -g @tmux2k-duo-fg \"#1688f0\" # this will get you duo blue shown above\nset -g @tmux2k-duo-bg \"#000000\" # this will set the bg for duo theme\n\n# to set powerline symbols\nset -g @tmux2k-right-sep  # alternate right status bar sep\nset -g @tmux2k-window-list-right-sep  # alternate window list right sep\n\n# to not show powerline\nset -g @tmux2k-show-powerline false\n\n# set session icon, accpets: `session`, 'window`, or any string\nset -g @tmux2k-session-icon \" #S\" # `#W` for window name\n```\n\n#### 🖌️ Customize Theme Colors\n\n##### Available Colors:\n\nBase Colors\n\n- `white`, `gray`, `black`\n- `light_blue`, `blue`, `dark_blue`\n- `light_green`, `green`, `dark_green`\n- `light_orange`, `orange`, `dark_orange`\n- `light_pink`, `pink`, `dark_pink`\n- `light_purple`, `purple`, `dark_purple`\n- `light_red`, `red`, `dark_red`\n- `light_yellow`, `yellow`, `dark_yellow`\n\nUI Colors\n\n- `text`: Text color. Default: `black`\n- `bg_main`: Background color. Default: `black`\n- `bg_alt`: Alt Background color. Default: `gray`\n- `message_bg`: Message background color. Default: `blue`\n- `message_fg`: Message text color. Default: `black`\n- `pane_active_border`: Active pane border color. Default: `blue`\n- `pane_border`: Inactive pane border color. Default: `black`\n- `prefix_highlight`: Highlight color for active prefix. Default: `blue`\n\nTo customize theme colors:\n\n```bash\nset -g @tmux2k-light-yellow '#f8c800' # change light yellow base color\nset -g @tmux2k-bg-main '#ffffff' # change bg to white\nset -g @tmux2k-prefix-highlight '#f8c800' # change prefix color\n```\n\n\u003e You may have to restart `tmux` for some changes to reflect\n\n### 🧩 Available Plugins\n\n#### 1. `bandwidth`\n\nShow network bandwidth usage\n\n- `tmux2k-bandwidth-network-name`: Network interface to track bandwidth of, default: `en0`\n- `tmux2k-bandwidth-up-icon`: Icon for bandwidth upload usage, default: ``\n- `tmux2k-bandwidth-down-icon`: Icon for bandwidth download usage, default: ``\n\n#### 2. `battery`\n\nShow battery stats and percentage\n\n- `tmux2k-battery-charging-icon`: Icon for charging status, default: ``\n- `tmux2k-battery-missing-icon`: Icon for missing battery, default: `󱉝`\n- `tmux2k-battery-percentage-0`: Icon for 0-25% battery, default: ``\n- `tmux2k-battery-percentage-1`: Icon for 25-50% battery, default: ``\n- `tmux2k-battery-percentage-2`: Icon for 50-75% battery, default: ``\n- `tmux2k-battery-percentage-3`: Icon for 75-90% battery, default: ``\n- `tmux2k-battery-percentage-4`: Icon for 90-100% battery, default: ``\n\n#### 3. `cpu`\n\nShow CPU usage information\n\n- `tmux2k-cpu-icon`: Icon for CPU usage, default: ``\n- `tmux2k-cpu-display-load`: Control CPU load display, default: `false`\n\n#### 4. `cpu-temp`\n\nShow CPU temperature\n\n- `tmux2k-cpu-temp-icon`: Icon for CPU temperature, default: ``\n- `tmux2k-cpu-temp-delimiter`: Decimal delimiter for CPU temperature, default: `.`\n- `tmux2k-cpu-temp-round`: Round CPU temperature to the nearest integer, default: `false`\n\n\n#### 5. `cwd`\n\nShow current working directory\n\n- `tmux2k-cwd-icon`: Icon for directory, default: ``\n\n#### 6. `git`\n\nShow Git branch and status information\n\n- `tmux2k-git-display-status`: Control git status display, default: `false`\n- `tmux2k-git-added-icon`: Icon for added files, default: ``\n- `tmux2k-git-modified-icon`: Icon for modified files, default: ``\n- `tmux2k-git-updated-icon`: Icon for updated files, default: ``\n- `tmux2k-git-deleted-icon`: Icon for deleted files, default: ``\n- `tmux2k-git-repo-icon`: Icon for repository, default: ``\n- `tmux2k-git-diff-icon`: Icon for differences, default: ``\n- `tmux2k-git-no-repo-icon`: Icon for no repository, default: ``\n\n#### 7. `gpu`\n\nShow GPU usage information\n\n- `tmux2k-gpu-icon`: Icon for GPU usage, default: ```\n\n#### 8. `group`\n\nGroup output from several other plugins to present information in more compact manner.\n\n- `tmux2k-group-plugins`: Set plugins for combining their output, default: `cpu ram uptime`\n- `tmux2k-group-delimiter`: Delimiter between plugin's output, default: ``\n\n#### 9. `network`\n\nShow network status and statistics\n\n- `tmux2k-network-ethernet-icon`: Icon for Ethernet connection, default: `󰈀`\n- `tmux2k-network-wifi-icon`: Icon for Wi-Fi connection, default: ``\n- `tmux2k-network-offline-icon`: Icon for offline status, default: `󰌙`\n\n#### 10. `ping`\n\nShow network ping statistics\n\n- `tmux2k-ping-server`: Host to ping, default: `google.com`\n\n#### 11. `pomodoro`\n\nShows pomodoro timer, needs [tmux-pomodoro-plus](https://github.com/olimorris/tmux-pomodoro-plus) (hit `prefix + p` to start)\n\n#### 12. `ram`\n\nShow RAM usage information\n\n- `tmux2k-ram-icon`: Icon for RAM usage, default: ``\n\n#### 13. `session`\n\nShows Current Session/Window with custom icon\n\n- `tmux2k-session-format`: Format for Tmux session, default: `#S`\n- `tmux2k-session-icon`: Icon for Tmux session, default: ``\n\n#### 14. `time`\n\nShow current time and date\n\n- `@tmux2k-time-format`: Sets the format for displaying the time. Default: `\"%a %I:%M %p\"`\n- `@tmux2k-time-icon`: Sets the icon for the time display. Default: ``\n\n#### 15. `weather`\n\nShow weather information\n\n- `@tmux2k-weather-scale`: Scale to use for temperature. Default: `c`, options: `[c, f, k]`\n- `@tmux2k-weather-display-location`: Whether to show location name. Default: `true`\n- `@tmux2k-weather-location`: Fixed location for weather. Default: `\"\"`\n\n#### 16. `window-list`\n\ntmux window list, this plugin is not supposed to be added to left / right plugin arrays, use the alignment option to position it.\n\n- `@tmux2k-window-list-alignment`: Sets the alignment of the window list. Default: `'absolute-centre'`\n   Available options: left | centre | right | absolute-centre\n- `@tmux2k-window-list-left-sep`: Sets the left separator for the window list. Default: ``\n- `@tmux2k-window-list-right-sep`: Sets the right separator for the window list. Default: ``\n- `@tmux2k-window-list-format`: Sets the format for the window list. Default: `'#I:#W'`\n- `@tmux2k-window-list-compact`: Enables or disables compact mode for the window list. Default: `false`\n\n#### 17. `uptime`\n\nShow current system uptime\n\n- `tmux2k-uptime-icon`: Icon for system uptime, default: `󰀠`\n\n#### 🪆 Add New Plugins\n\nTo add a new plugin:\n\n- Copy `plugin/custom.sh` and rename it to match your plugin name.\n- Update the new plugin script to `echo` the expected output.\n- Add color declaration for your plugin name into the `plugin_colors` array in `main.sh`\n\n\u003e The plugin name and script file name must match e.g: plugin named `foo` should have a file called `scripts/foo.sh`\n\n#### Gemeral Plugin Configs\n\n```bash\n# set the left and right plugin sections\nset -g @tmux2k-left-plugins \"session git cpu ram\"\nset -g @tmux2k-right-plugins \"battery network time\"\n\n# contorl refresh rate, applies to bandwidth, ping\nset -g @tmux2k-refresh-rate 1\n\n# to customize plugin colors\nset -g @tmux2k-[plugin-name]-colors \"[background] [foreground]\"\nset -g @tmux2k-cpu-colors \"red black\" # set cpu plugin bg to red, fg to black\n```\n\n## 🏗️ What's Next\n\n- You tell me!\n\n## 🧑‍💻 Behind The Code\n\n### 🌈 Inspiration\n\nI came across [dracula/tmux](https://github.com/dracula/tmux) sometime back and I wanted to create a more customizable and easy to expand solution.\n\n### 💡 Challenges/Learnings\n\n- Learned a lot about the `tmux` and `tpm` ecosystem.\n- Did some fancy shell scripting.\n\n## What's next\n\n### To-Do\n\nYou tell me!\n\n### 🧰 Tooling\n\n- [dots2k](https://github.com/2kabhishek/dots2k) — Dev Environment\n- [nvim2k](https://github.com/2kabhishek/nvim2k) — Personalized Editor\n- [sway2k](https://github.com/2kabhishek/sway2k) — Desktop Environment\n- [qute2k](https://github.com/2kabhishek/qute2k) — Personalized Browser\n\n### 🔍 More Info\n\n- [tmux-tea](https://github.com/2kabhishek/tmux-tea) — Simple and powerful tmux session manager\n- [tmux-tilit](https://github.com/2kabhishek/tmux-tilit) — Turns tmux into a terminal window manager\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cstrong\u003e⭐ hit the star button if you found this useful ⭐\u003c/strong\u003e\u003cbr\u003e\n\n\u003ca href=\"https://github.com/2KAbhishek/tmux2k\"\u003eSource\u003c/a\u003e\n| \u003ca href=\"https://2kabhishek.github.io/blog\" target=\"_blank\"\u003eBlog \u003c/a\u003e\n| \u003ca href=\"https://twitter.com/2kabhishek\" target=\"_blank\"\u003eTwitter \u003c/a\u003e\n| \u003ca href=\"https://linkedin.com/in/2kabhishek\" target=\"_blank\"\u003eLinkedIn \u003c/a\u003e\n| \u003ca href=\"https://2kabhishek.github.io/links\" target=\"_blank\"\u003eMore Links \u003c/a\u003e\n| \u003ca href=\"https://2kabhishek.github.io/projects\" target=\"_blank\"\u003eOther Projects \u003c/a\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2kabhishek%2Ftmux2k","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2kabhishek%2Ftmux2k","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2kabhishek%2Ftmux2k/lists"}