vlt - Minimalist Secure Vault (Vvault CLI)
Project description
🛡️ Sololc Vvault (vlt)
An elegant, functional, and secure CLI authenticator built for power users.
Vvault (pronounced Volt) is a modern 2FA (Two-Factor Authentication) secret manager designed for the terminal. It balances industrial-grade security with a "bright and shiny" user experience, allowing you to manage your TOTP tokens with style and speed.
✨ Features
- ⚡️ Live Dashboard: A visually stunning, real-time terminal UI to monitor all your TOTP codes and their expiration countdowns.
- 🔒 Local-First Security: Secrets are stored physically in the
~/.vlt/directory with strict file permissions. - 📂 Smart Import: Seamlessly import accounts via QR code images or standard
otpauth://URL links. - 📋 Clipboard Integration: Copy verification codes directly to your clipboard with a single flag for lightning-fast logins.
- 🛠️ Modern Tech Stack: Powered by
uv,Typer,Rich, andQReaderfor a lightweight yet robust experience.
🚀 Installation
Ensure you have Python 3.11+ installed. We recommend using uv for the fastest installation and performance.
# Clone the repository
git clone [https://github.com/nuv0x/Vvault.git](https://github.com/nuv0x/Vvault.git)
cd Vvault
# Install dependencies and install the tool in editable mode
uv sync
pip install -e .
📖 Usage Guide
Vvault uses the short and punchy vlt command.
- Initialization Set up your secure storage directory at ~/.vlt/.
vlt init
- Adding Accounts You can add accounts manually or import them intelligently via QR codes.
Manual Add:
vlt add github --secret KHR2UEJ33JJG... --issuer GitHub --category Dev
QR Code Import:
vlt import --qr ./path/to/qr_code.png
URL Import:
vlt import --url "otpauth://totp/Service:User?secret=XYZ..."
- Management & Viewing Launch Live Dashboard:
vlt dash
Get a Single Code:
vlt get github # Display the code
vlt get github --copy # Display and automatically copy to clipboard
List All Accounts:
vlt list
- Backup Keep your data safe by exporting your vault.
vlt backup ./my_backup.yaml
🛠️ Project Structure
The project follows a modular, functional design for clarity and maintainability:
- src/relay_2fa/core/: Core logic layer containing TOTP generation, physical storage, and vault operations.
- src/relay_2fa/main.py: Interaction layer featuring the polished CLI interface built with Typer and Rich.
- ~/.vlt/: The default local data storage path.
🤝 Contributing
Contributions are welcome! If you have ideas for new features (such as supporting the Google Migration protocol or adding Master Password encryption), please feel free to:
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sololc_vvault-0.1.1.tar.gz.
File metadata
- Download URL: sololc_vvault-0.1.1.tar.gz
- Upload date:
- Size: 45.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d55d01625241640be8c345a5884504d15ddbc621de548c130462bfd6b1d8875
|
|
| MD5 |
2a87c23804c49e57c872b5644e9549e3
|
|
| BLAKE2b-256 |
ea997068d0cfc5066563da701bacfa278e68b7f4797c22bf42709fe9c4939a02
|
File details
Details for the file sololc_vvault-0.1.1-py3-none-any.whl.
File metadata
- Download URL: sololc_vvault-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9e68de076236215f8431f1106d1871d65751f692948ec44b5710ed06175ebf70
|
|
| MD5 |
c9070c7dc9b7012d3a5dbed89d7b776c
|
|
| BLAKE2b-256 |
3e2f219b4780fe141e02e6c5d505d20fa4f525b141af0a9b34b7f1443cc9e0e6
|