{"id":13740217,"url":"https://github.com/maxrodrigo/tmux-nordvpn","last_synced_at":"2025-05-08T19:36:45.678Z","repository":{"id":146791057,"uuid":"225597652","full_name":"maxrodrigo/tmux-nordvpn","owner":"maxrodrigo","description":"Monitor NordVPN connection status from Tmux. ","archived":false,"fork":false,"pushed_at":"2023-05-07T09:27:15.000Z","size":24,"stargazers_count":18,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-04T04:06:19.083Z","etag":null,"topics":["bash","command-line","dotfiles","hacktoberfest","nordvpn","rising","screen","shell","tmux","tmux-conf","tmux-nordvpn","tmux-option","tmux-plugin","tmux-plugins","tmux-theme","tpm","tpm-plugin","unixporn","vpn","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/maxrodrigo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"maxrodrigo","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-12-03T10:55:36.000Z","updated_at":"2024-05-26T13:49:03.000Z","dependencies_parsed_at":"2024-01-25T05:49:40.564Z","dependency_job_id":null,"html_url":"https://github.com/maxrodrigo/tmux-nordvpn","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxrodrigo%2Ftmux-nordvpn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxrodrigo%2Ftmux-nordvpn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxrodrigo%2Ftmux-nordvpn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxrodrigo%2Ftmux-nordvpn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxrodrigo","download_url":"https://codeload.github.com/maxrodrigo/tmux-nordvpn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224765420,"owners_count":17366117,"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":["bash","command-line","dotfiles","hacktoberfest","nordvpn","rising","screen","shell","tmux","tmux-conf","tmux-nordvpn","tmux-option","tmux-plugin","tmux-plugins","tmux-theme","tpm","tpm-plugin","unixporn","vpn","zsh"],"created_at":"2024-08-03T04:00:44.596Z","updated_at":"2024-11-15T10:30:22.091Z","avatar_url":"https://github.com/maxrodrigo.png","language":"Shell","funding_links":["https://github.com/sponsors/maxrodrigo"],"categories":["Status Bar"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/maxrodrigo/tmux-nordvpn\"\u003e\n        \u003cimg src=\"assets/tmux-nordvpn-logo.png\" alt=\"tmux-nordvpn logo\" width=\"128\"\u003e\n    \u003c/a\u003e\n    \u003ch3 align=\"center\"\u003eNordVPN Tmux Plugin\u003c/h3\u003e\n    \u003cp align=\"center\"\u003e\n        Monitor \u003ca href=\"https://nordvpn.com/\"\u003eNordVPN\u003c/a\u003e connection status from Tmux.\n    \u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n        \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/maxrodrigo/tmux-nordvpn\"\u003e\n    \u003c/p\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n* [Demo](#demo)\n* [Getting Started](#getting-started)\n    * [Installation](#installation)\n    * [Requirements](#requirements)\n* [Usage](#usage)\n    * [Supported Format Strings](#supported-format-strings)\n    * [Options](#options)\n    * [Examples](#examples)\n* [Status Update Interval](#status-update-interval)\n* [Contributing](#contributing)\n\n## Demo\n\n![tmux-nordvpn demo](assets/demo.svg)\n\n## Getting Started\n\n### Installation\n\n#### Tmux Plugin Manager (recommended)\n\nAdd plugin to the list of [TPM](https://github.com/tmux-plugins/tpm) plugins in `.tmux.conf`:\n\n```sh\nset -g @plugin 'maxrodrigo/tmux-nordvpn'\n```\n\nHit `prefix + I` to fetch the plugin and source it.\n\nIf format strings are added to `status-right`, they should now be visible.\n\n#### Manual Installation\n\nClone the repository:\n\n```sh\ngit clone https://github.com/maxrodrigo/tmux-nordvpn ~/.tmux/tmux-nordvpn\n```\n\nAdd this line to the bottom of `.tmux.conf`:\n\n```txt\nrun-shell ~/.tmux/tmux-nordvpn/nordvpn.tmux\n```\n\nReload Tmux environment:\n\n```sh\ntmux source-file ~/.tmux.conf\n```\n\nIf format strings are added to `status-right`, they should now be visible.\n\n### Requirements\n\nThe plugin relays on the NordVPN native application to pull the current status.\nThe command line tool is required.\n\nNordVPN setup tutorials: https://support.nordvpn.com/FAQ/Setup-tutorials/\n\n## Usage\n\nAdd any of the [supported format strings](#supported-format-strings) to `status-right` or `status-left`.\n\n```sh\nset -g status-right 'NordVPN: #{nordvpn_status_color}#{nordvpn_status} (#{nordvpn_country})'\n```\n\n### Supported Format Strings\n\n- `#{nordvpn_status}` - connection status.\n- `#{nordvpn_server}` - current server.\n- `#{nordvpn_country}` - current connection country.\n- `#{nordvpn_city}` - current connection city.\n- `#{nordvpn_ip}` - current connection IP address.\n- `#{nordvpn_status_color}` - change foreground and background color based on the VPN status.\n\n### Options\n\nHere are all available options with their default values.\n\n```sh\n@nordvpn_exclude_server_domain true # remove \"nordvpn.com\" from the server name.\n\n@nordvpn_connected_text \"Connected\" # text to display when connected\n@nordvpn_connecting_text \"Connecting\" # text to display when connecting\n@nordvpn_disconnected_text \"Disconnected\" # text to display when disconnected\n\n@nordvpn_connected_fg_color \"green\" # foreground color when connected.\n@nordvpn_connecting_fg_color \"yellow\" # foreground color when connecting.\n@nordvpn_disconnected_fg_color \"red\" # foreground color when disconnected.\n\n@nordvpn_connected_bg_color \"\" # background color when connected.\n@nordvpn_connecting_bg_color \"\" # background color when connecting.\n@nordvpn_disconnected_bg_color \"\" # background color when disconnected.\n```\n\n### Examples\n\n```sh\n# .tmux.conf\nset -g @nordvpn_connected_text \"c\"\nset -g @nordvpn_connecting_text \"…\"\nset -g @nordvpn_disconnected_text \"d\"\n\nset -g status-left \"#[fg=blue]vpn: #{nordvpn_status_color}#{nordvpn_status} #[fg=cyan]#{nordvpn_server}\"\n```\n\n```sh\n# .tmux.conf\nset -g @nordvpn_connected_text \"Connected to\"\nset -g @nordvpn_connecting_text \"Connecting to\"\n\nset -g status-left \"NordVPN #{nordvpn_status_color}#{nordvpn_status} #{nordvpn_city}, #{nordvpn_country} [#{nordvpn_ip}]\"\n```\n\n## Status Update Interval\n\nStatus update won't be instant. The duration depends on the `status-interval` Tmux option. You can set `status-interval` to a low number to make the refresh faster.\n\n```sh\nset -g status-interval 5\n```\n\n## Contributing\n\nContributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.\n\nThe best way to send feedback is to file an issue at https://github.com/maxrodrigo/tmux-nordvpn/issues\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxrodrigo%2Ftmux-nordvpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxrodrigo%2Ftmux-nordvpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxrodrigo%2Ftmux-nordvpn/lists"}