Repository navigation
CryptVault v3.2.3 — Public release
·
45 commits
to main
since this release
CryptVault v3.2.2
CryptVault delivers AI-assisted cryptocurrency analysis with rich pattern detection and polished charting experiences.
Quick Start
Installation (Works on Ubuntu, macOS, Windows)
# Clone repository
git clone https://github.com/MeridianAlgo/Cryptvault.git
cd Cryptvault
# Install dependencies
pip install -r requirements.txt
# Run demo
python cryptvault_cli.py --demo
# Analyze Bitcoin
python cryptvault_cli.py BTC 60 1d
# Analyze stocks
python cryptvault_cli.py AAPL 60 1dPlatform Support
- ✅ Ubuntu/Linux - Fully tested and supported
- ✅ macOS - Fully tested and supported
- ✅ Windows - Fully tested and supported
- ✅ Python 3.8-3.12 - All versions supported
Features
- 50+ Chart Patterns - Reversal, continuation, harmonic, candlestick patterns
- ML Predictions - Ensemble models with 8+ algorithms
- 70+ Supported Assets - Major cryptocurrencies and popular stocks
- Terminal & Desktop Charts - ASCII and matplotlib visualization
- Portfolio Analysis - Multi-asset comparison and optimization
- Interactive CLI - Command-line interface with live analysis
- Cross-Platform - Works on Ubuntu, macOS, and Windows
Supported Assets
Cryptocurrencies (50+)
BTC, ETH, USDT, BNB, SOL, XRP, USDC, ADA, AVAX, DOGE, TRX, DOT, MATIC, LINK, TON, SHIB, LTC, BCH, UNI, ATOM, XLM, XMR, ETC, HBAR, FIL, APT, ARB, VET, NEAR, ALGO, ICP, GRT, AAVE, MKR, SNX, SAND, MANA, AXS, FTM, THETA, EOS, XTZ, FLOW, EGLD, ZEC, CAKE, KLAY, RUNE, NEO, DASH, and more...
Stocks (20+)
AAPL, TSLA, GOOGL, MSFT, NVDA, AMZN, META, NFLX, AMD, INTC, COIN, SQ, PYPL, V, MA, JPM, BAC, WMT, DIS, UBER, and more...
Documentation
Core Documentation
- Main README - Complete product overview and features
- CLI vs Core - Difference between cryptvault_cli.py and cryptvault.py
- Final System Summary - System capabilities and achievements
- Enhanced ML System - Machine learning implementation details
- Beautiful Candlestick Charts - Charting system documentation
- Changelog - Version history and updates
- Release Notes v3.1.0 - Latest release information
- Project Status - Current development status
- Documentation Index - Complete documentation index
Setup & Installation
- Setup Guide - Complete installation guide
- Installation Verification - Verify your installation
- Platform Support - Ubuntu, macOS, Windows compatibility guide
Policies & Contributing
- Contributing Guidelines - How to contribute to CryptVault
- Code of Conduct - Community guidelines
- Contributing Policy - Detailed contribution policy
- Security Policy - Security guidelines and reporting
- License - MIT License terms
CLI vs Core Application
cryptvault_cli.pyis the interactive command-line entry point. It orchestrates data ingestion, pattern recognition, model execution, and optional desktop visualization for day-to-day usage.cryptvault.pyfocuses on terminal-based chart rendering. It offers an expressive ASCII dashboard and low-level access for custom scripts or integrations that need the charting layer without the full CLI orchestration.
Use the CLI for end-to-end analysis, multi-asset comparisons, and automation. Use the core script when you need lightweight chart output or want to embed CryptVault visuals in other tooling.
Repository Structure
.
├── config/ # Environment templates and overrides
├── cryptvault/ # Core analysis engine, indicators, ML modules
├── docs/ # Primary documentation bundle
│ ├── main_README.md # Detailed platform overview & usage
│ ├── setup/ # Installation & verification guides
│ ├── policies/ # Governance and contribution docs
│ └── ... # Additional deep dives and references
├── logs/ # Runtime logs (`cryptvault.log`)
├── tests/ # Pytest suite for parsers, indicators, ML
├── cryptvault.py # Terminal charting application
├── cryptvault_cli.py # Full-featured CLI and desktop launcher
├── requirements.txt # Python dependencies
├── setup.py # Packaging metadata
└── LICENSE # MIT license terms
Next Steps
- Review
docs/main_README.mdfor advanced usage patterns and examples. - Copy
config/.env.exampleto.envif you need to override defaults. - Run
python -m pytest tests/to validate installation.