Skip to main content

MinakiLabs CLI for managing WireGuard VPN tunnels - fixed sub-domains

Project description

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

MinakiLabs

🛰️ 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:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minaki_vpn-0.1.1.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minaki_vpn-0.1.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file minaki_vpn-0.1.1.tar.gz.

File metadata

  • Download URL: minaki_vpn-0.1.1.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for minaki_vpn-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1002a243dfdcac9c99baddd6b7b8e779dec4ed3e39875f52d44b5746f1ecac8b
MD5 9b403fc48552258419dfa77b0f80246b
BLAKE2b-256 82abb74e89f2f8a8590ea34215c9e0937e020c172437c1b19077b3b10d43ea8c

See more details on using hashes here.

File details

Details for the file minaki_vpn-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: minaki_vpn-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for minaki_vpn-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b196d1bae99c5b47c9e8b447465cc569359a5d2eb7863c0d8a4903e2944209b
MD5 b3be9e709e184ffff619508c12cd8abd
BLAKE2b-256 c13c6a34680a44ce47c73142e249bc911b24da09656a2197fc87f15be577d1e9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page