| Name | minaki-vpn JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | MinakiLabs CLI for managing WireGuard VPN tunnels - fixed sub-domains |
| upload_time | 2025-07-17 15:29:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
vpn
cli
wireguard
minaki
tunnel
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Great — since this is proprietary software and not open source, we’ll update your README.md accordingly by:
• Removing references to MIT or open licensing
• Adding a “License & Usage” section clarifying restrictions
• Branding it clearly as proprietary and commercial
Here’s your updated README.md for minaki-vpn:
⸻
# minaki-vpn
> 🛰️ Official CLI for MinakiLabs — easily connect to your secure WireGuard-based VPN in seconds.
---
## ✨ Features
- 🔐 Secure API key authentication
- 📦 Pull WireGuard configuration directly from Minaki backend
- ⚡ One-command connect, disconnect, restart
- 📁 Config and key storage in `~/.minaki/`
- 💬 Beautiful terminal output using `rich`
- 🧰 CLI tool installable via pip or PyPI
---
## 📦 Installation
Install with pip:
```bash
pip install minaki-vpn
Or from source:
git clone https://github.com/minakilabs/minaki-vpn.git
cd minaki-vpn
pip install .
⸻
⚙️ Available Commands
Command Description
configure Save your API key locally to ~/.minaki/cli-config.json
status Check your VPN lease status and IP assignment
pull-config Download your WireGuard .conf file from the API
connect Bring up the VPN tunnel using wg-quick
disconnect Tear down the VPN tunnel
restart Restart the VPN (disconnect + reconnect)
install-wg Check if WireGuard is installed; prompt if not
⸻
🛠️ Quick Start
# 1. Set your API Key
minaki-vpn configure
# 2. Connect to the VPN
minaki-vpn connect
# 3. View current tunnel status
minaki-vpn status
# 4. Disconnect when done
minaki-vpn disconnect
⸻
🔐 Authentication & Config Files
• Your API key is securely stored in:
~/.minaki/cli-config.json
• VPN configuration is downloaded to:
~/.minaki/wg2.conf
⸻
🧠 Requirements
• Python 3.7+
• WireGuard tools (wg-quick, wg)
• Valid API access with MinakiLabs (https://minaki.io)
⸻
📛 License & Usage
This is proprietary software owned by MinakiLabs, Inc.
Usage is subject to the terms and conditions of your commercial license agreement.
You may not copy, redistribute, or modify this software without explicit permission.
For licensing inquiries, contact support@minakilabs.com.
⸻
👤 Author
Andrew Polykandriotis
CEO, MinakiLabs
📧 support@minakilabs.com
Raw data
{
"_id": null,
"home_page": null,
"name": "minaki-vpn",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "vpn, cli, wireguard, minaki, tunnel",
"author": null,
"author_email": "Andrew Polykandriotis <support@minakilabs.com>",
"download_url": "https://files.pythonhosted.org/packages/82/ab/b74e89f2f8a8590ea34215c9e0937e020c172437c1b19077b3b10d43ea8c/minaki_vpn-0.1.1.tar.gz",
"platform": null,
"description": "Great \u2014 since this is proprietary software and not open source, we\u2019ll update your README.md accordingly by:\n\t\u2022\tRemoving references to MIT or open licensing\n\t\u2022\tAdding a \u201cLicense & Usage\u201d section clarifying restrictions\n\t\u2022\tBranding it clearly as proprietary and commercial\n\nHere\u2019s your updated README.md for minaki-vpn:\n\n\u2e3b\n\n\n# minaki-vpn\n\n\n\n> \ud83d\udef0\ufe0f Official CLI for MinakiLabs \u2014 easily connect to your secure WireGuard-based VPN in seconds.\n\n---\n\n## \u2728 Features\n\n- \ud83d\udd10 Secure API key authentication\n- \ud83d\udce6 Pull WireGuard configuration directly from Minaki backend\n- \u26a1 One-command connect, disconnect, restart\n- \ud83d\udcc1 Config and key storage in `~/.minaki/`\n- \ud83d\udcac Beautiful terminal output using `rich`\n- \ud83e\uddf0 CLI tool installable via pip or PyPI\n\n---\n\n## \ud83d\udce6 Installation\n\nInstall with pip:\n\n```bash\npip install minaki-vpn\n\nOr from source:\n\ngit clone https://github.com/minakilabs/minaki-vpn.git\ncd minaki-vpn\npip install .\n\n\n\u2e3b\n\n\u2699\ufe0f Available Commands\n\nCommand\tDescription\nconfigure\tSave your API key locally to ~/.minaki/cli-config.json\nstatus\tCheck your VPN lease status and IP assignment\npull-config\tDownload your WireGuard .conf file from the API\nconnect\tBring up the VPN tunnel using wg-quick\ndisconnect\tTear down the VPN tunnel\nrestart\tRestart the VPN (disconnect + reconnect)\ninstall-wg\tCheck if WireGuard is installed; prompt if not\n\n\n\u2e3b\n\n\ud83d\udee0\ufe0f Quick Start\n\n# 1. Set your API Key\nminaki-vpn configure\n\n# 2. Connect to the VPN\nminaki-vpn connect\n\n# 3. View current tunnel status\nminaki-vpn status\n\n# 4. Disconnect when done\nminaki-vpn disconnect\n\n\n\u2e3b\n\n\ud83d\udd10 Authentication & Config Files\n\t\u2022\tYour API key is securely stored in:\n\n~/.minaki/cli-config.json\n\n\n\t\u2022\tVPN configuration is downloaded to:\n\n~/.minaki/wg2.conf\n\n\n\n\u2e3b\n\n\ud83e\udde0 Requirements\n\t\u2022\tPython 3.7+\n\t\u2022\tWireGuard tools (wg-quick, wg)\n\t\u2022\tValid API access with MinakiLabs (https://minaki.io)\n\n\u2e3b\n\n\ud83d\udcdb License & Usage\n\nThis is proprietary software owned by MinakiLabs, Inc.\nUsage is subject to the terms and conditions of your commercial license agreement.\nYou may not copy, redistribute, or modify this software without explicit permission.\n\nFor licensing inquiries, contact support@minakilabs.com.\n\n\u2e3b\n\n\ud83d\udc64 Author\n\nAndrew Polykandriotis\nCEO, MinakiLabs\n\ud83d\udce7 support@minakilabs.com\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MinakiLabs CLI for managing WireGuard VPN tunnels - fixed sub-domains",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://minaki.io",
"Repository": "https://github.com/minakilabs/minaki-vpn"
},
"split_keywords": [
"vpn",
" cli",
" wireguard",
" minaki",
" tunnel"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c13c6a34680a44ce47c73142e249bc911b24da09656a2197fc87f15be577d1e9",
"md5": "b3be9e709e184ffff619508c12cd8abd",
"sha256": "4b196d1bae99c5b47c9e8b447465cc569359a5d2eb7863c0d8a4903e2944209b"
},
"downloads": -1,
"filename": "minaki_vpn-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3be9e709e184ffff619508c12cd8abd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8316,
"upload_time": "2025-07-17T15:29:27",
"upload_time_iso_8601": "2025-07-17T15:29:27.000425Z",
"url": "https://files.pythonhosted.org/packages/c1/3c/6a34680a44ce47c73142e249bc911b24da09656a2197fc87f15be577d1e9/minaki_vpn-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "82abb74e89f2f8a8590ea34215c9e0937e020c172437c1b19077b3b10d43ea8c",
"md5": "9b403fc48552258419dfa77b0f80246b",
"sha256": "1002a243dfdcac9c99baddd6b7b8e779dec4ed3e39875f52d44b5746f1ecac8b"
},
"downloads": -1,
"filename": "minaki_vpn-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9b403fc48552258419dfa77b0f80246b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6784,
"upload_time": "2025-07-17T15:29:27",
"upload_time_iso_8601": "2025-07-17T15:29:27.734192Z",
"url": "https://files.pythonhosted.org/packages/82/ab/b74e89f2f8a8590ea34215c9e0937e020c172437c1b19077b3b10d43ea8c/minaki_vpn-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 15:29:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "minakilabs",
"github_project": "minaki-vpn",
"github_not_found": true,
"lcname": "minaki-vpn"
}
