AetherVault — User Guide
Table of Contents
- Getting Started
- Installation
- Quick Start
- Features
- Configuration
- Data Management
- Troubleshooting
- FAQ
Getting Started
AetherVault is a portable, local password vault that stores your credentials in an encrypted SQLite database. All passwords are encrypted with AES-256 using a key derived from your master password. The application runs on Windows, Linux, and macOS.
Key Benefits
- Portable — single file database, easy to back up and move
- Secure — AES-256 encryption, PBKDF2 key derivation, auto-lock on inactivity
- Self-contained — no cloud, no servers, no subscriptions
Installation
System Requirements
- OS: Windows 10+, Linux (any modern distro), macOS 12+
- Python: 3.10+
- Dependencies: cryptography (always); PySide6 (desktop GUI only)
Install from PyPI
The PyPI distribution is aethervault-py; the app/import/CLI name is aethervault.
The desktop GUI is the gui extra; a plain install is headless (SDK + CLI only).
pip install 'aethervault-py[gui]' # desktop app (pulls in PySide6/Qt)
aethervault
For a headless install (server, CI, or a phone via Termux on Android) — no Qt:
pip install aethervault-py # cryptography only
aethervault-cli --help
See SDK.md for the full SDK and CLI reference.
Setup from Source
git clone https://github.com/AetherSolDev/AetherVault.git
cd AetherVault
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -e '.[gui]' # or: pip install -e . (headless)
aethervault
CLI Reference
| Command |
Description |
aethervault |
Launch GUI (auto-detaches from terminal on Unix) |
aethervault --version |
Show installed version |
aethervault --debug |
Launch with debug logging to terminal |
aethervault --upgrade / -u |
Check for updates and auto-upgrade (pip install aethervault-py, or git pull for source installs) |
aethervault --foreground / -f |
Keep terminal attached (for debugging) |
aethervault-cli <command> |
Headless CLI — see SDK.md |
Standalone Executable
A pre-built executable is available (see Releases). No Python installation required.
Quick Start
First Run (Setting Up)
- Launch the application.
- You will be greeted with the Setup Master Password screen.
- Enter a strong master password (minimum 8 characters).
- Click Set Master Password.
- You will be redirected to the login screen. Enter your new password to unlock the vault.
Daily Use
- Launch the application.
- Enter your master password and click Login.
- The main interface shows your credential list (left) and the edit form (right).
- Click Add New to create a new entry, or select an existing entry to view/edit.
Features
Credential Management
- Add, edit, and delete credential entries
- Fields: Title, URL, Username, Email, Password, Phone, Address, Category, Tags
- Notes — click the ▶ Notes toggle to expand the rich-text editor (with B/I/U
formatting); a preview of the first line shows when collapsed
- Custom Fields — click Custom Fields... to open a dialog for adding extra
field/value pairs (e.g. API keys, recovery codes); the field count shows next to the button
- Search/filter by title, username, URL, category, or notes
Strong Password Generator
- Configurable length (8–64 characters)
- Toggle character sets: lowercase, uppercase, digits, symbols
- One-click "Use Password" inserts into the form
Auto-Lock Security
- Configurable inactivity timeout (1, 3, 5, 10, 30 minutes, or Never)
- Application locks automatically after inactivity
- Clipboard is cleared on lock
Clipboard Security
- Copy buttons for password, username, and URL
- Clipboard auto-clears after 15 seconds
- Clipboard cleared on application lock
Two-Factor (TOTP) Codes
- Store an authenticator secret on any entry — AetherVault generates the rolling
6-digit code, so a separate authenticator app isn't needed.
- Set up: open an entry in edit mode and click Set up 2FA..., then paste the
site's
otpauth:// URI or its base32 secret. You can also paste the site's recovery
codes and verify the current code before saving.
- Use: the form shows the live code with a 30-second countdown; Copy Code copies
it (clipboard clears after 15s). The code updates automatically.
- Recovery codes: expand ▶ Recovery Codes to view or copy them.
- Remove: in edit mode, click Remove 2FA to clear the secret and codes.
- Secrets and recovery codes are encrypted at rest like passwords and are excluded
from CSV exports.
- Wrong code? TOTP needs an accurate clock — make sure your computer's date/time is
correct and set to sync automatically.
Data Management
- Auto-Backup: Automatic backup on save and application shutdown
- Manual Backup:
File > Backup Vault
- Restore:
File > Restore Vault — select a .db backup file
- Export:
File > Export Vault (CSV) — unencrypted plain text
- Import:
File > Import Vault (CSV) — add/update from CSV
Duplicate Removal
Tools > Find and Remove Duplicates
- Removes entries with duplicate Title + Username (keeps oldest)
- Creates a timestamped backup before removal for safety
Configuration
Auto-Lock Settings
- Access via
Settings > Auto-Lock menu
- Options: After 1, 3, 5, 10, 30 minutes, or Never
- Setting persists across sessions in
.app_settings.json
Duress Password (optional)
- Configured via
Settings > Duress Password... (requires your master password)
- If the duress password is entered at the login screen, the vault and all
backups are permanently destroyed and the app exits.
- From an observer's point of view it looks like a normal failed login.
- Warning: there is no recovery — data is gone for good. Use only under
physical coercion.
Data File Locations
All files are stored in the application directory:
| File |
Purpose |
data/aethervault.db |
Encrypted vault (SQLite) |
data/aethervault.db.bak |
Auto-generated backup files |
data/.master.key |
Master password hash (PBKDF2) |
data/.duress.key |
Duress password hash (PBKDF2, optional) |
data/.app_settings.json |
Application settings (unencrypted) |
Remote Backup Folder
In addition to local backups, AetherVault can mirror every backup to a second
location — a NAS share, USB drive, or any other mounted folder — as a
dual-backup safety copy.
- Set it up:
Settings > Remote Backup Folder... and pick a directory. The
choice is saved and reused for all future backups.
- What happens: every manual backup (
File > Backup) and every automatic
pre-operation backup (before import, duplicate removal, etc.) is also copied
to the folder, rotated to keep the 5 most recent copies — matching the local
rotation.
- Security: the remote copy is the same encrypted
.db.bak file, so it is
safe to leave on a NAS or shared drive. The duress wipe does not touch the
remote folder — it survives as your recovery copy.
- Clear it: run
Settings > Remote Backup Folder... again and click
Cancel with no folder selected, then confirm "Clear".
- Restore from it: use
File > Restore Vault and navigate to the folder —
the .db.bak filter is enabled.
Troubleshooting
"Icon file not found" warning in console
The app icon is optional. The application will run fine without it. To resolve, place an icon file in an assets/ directory next to the executable.
Can't open the vault after restore
Restore requires the same master password that was used when the backup was created. If you've changed your master password since the backup, the old backup won't work.
App locks too quickly / too slowly
Adjust the auto-lock timeout in Settings > Auto-Lock. The default is 3 minutes.
FAQ
- Can I recover a forgotten master password? No. The master password is not stored; only a one-way hash is saved. Without the original password, your vault is permanently inaccessible.
- Is my data secure? Yes. All passwords are encrypted with AES-256 (Fernet). The encryption key is derived from your master password using PBKDF2 with 600,000 iterations.
- Can I use the same database on multiple computers? Yes. Copy the
data/aethervault.db file to another computer with the application installed. Use the same master password to unlock it.
- How do I migrate from another password manager? Export your data to CSV and import it via
File > Import Vault (CSV). The CSV must have columns: title, username, password, url, email, phone, address, category, notes.