Skip to main content

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

Metadata

Release files for minaki-vpn 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minaki-vpn 0.1.1
File Size Uploaded Provenance
minaki_vpn-0.1.1.tar.gz 6.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for minaki-vpn 0.1.1
File Interpreter ABI Platform
minaki_vpn-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 15.1 kB

Release files / minaki_vpn-0.1.1.tar.gz

Download URL minaki_vpn-0.1.1.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1002a243dfdcac9c99baddd6b7b8e779dec4ed3e39875f52d44b5746f1ecac8b
BLAKE2b-256 checksum
How to use checksums
82abb74e89f2f8a8590ea34215c9e0937e020c172437c1b19077b3b10d43ea8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / minaki_vpn-0.1.1-py3-none-any.whl

Download URL minaki_vpn-0.1.1-py3-none-any.whl
Size 8.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b196d1bae99c5b47c9e8b447465cc569359a5d2eb7863c0d8a4903e2944209b
BLAKE2b-256 checksum
How to use checksums
c13c6a34680a44ce47c73142e249bc911b24da09656a2197fc87f15be577d1e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Security for minaki-vpn 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page