Decision-first cloud visibility for non-technical leaders.
FinLens converts complex AWS infrastructure into a clear, interactive report you can review locally.
- No SaaS dependency
- No always-on backend requirement
- No live telemetry lock-in
- Deterministic, auditable snapshots
- Runs locally against configured AWS profiles.
- Collects infrastructure snapshots across selected services and regions.
- Produces a self-contained web dashboard.
- Lets teams review cloud posture and inventory clearly.
./start-finlens.shDefault dashboard URL: http://localhost:5173
- Python
3.8+ - Docker + Docker Compose (recommended path)
- AWS credentials configured locally
aws configure --profile your-profile-name
aws sts get-caller-identity --profile your-profile-nameUpdate config/profiles.yaml:
profiles:
- name: your-profile-name
environment: production
enabled: true./start-finlens.shUseful Docker commands:
docker compose logs -f
docker compose restart
docker compose downpip install -r requirements.txt
cd frontend && npm install && cd ..
python finlens.py# Terminal 1
python frontend/api_server.py
# Terminal 2
cd frontend
npm run dev- Multi-account inventory with profile-based scanning
- Cross-region coverage with configurable include/exclude regions
- 75+ AWS services across compute, storage, database, networking, security, and more
- Official AWS icon mapping and service-priority overview ordering
- Service detail exports (CSV), column-order preservation, and structured tag popovers
- Interactive dashboards with filtering and drill-downs
- Profiles: config/profiles.yaml
- Regions: config/regions.yaml
- Services: config/services.yaml
ls -la ~/.aws/
cat ~/.aws/credentials
aws sts get-caller-identity --profile your-profile-nameIf using Docker after credential changes:
docker compose restartsudo usermod -aG docker $USERThen log out and log back in.
- Project overview: PROJECT_OVERVIEW.md
- Business requirements: BRD — Business Requirements Document.md
- Functional requirements: FRD — Functional Requirements Document.md
- Non-functional requirements: NFR — Non-Functional Requirements Document.md
- Architecture: System Architecture Document (SAD).md
- ec2 # EC2 instances
- vpc # VPC resources
### Step 4: Run FinLens Scan
```bash
# Make sure virtual environment is activated
source venv/bin/activate
# Run the scan
python finlens.py
That's it! FinLens will:
- Automatically read all profiles from
config/profiles.yaml - Scan only the included regions from
config/regions.yaml - Collect data for included services from
config/services.yaml - Generate JSON files in
data/<profile-name>/services/directory
Scan results are saved in:
data/
├── profile-1/
│ └── services/
│ ├── ec2.json
│ ├── vpc.json
│ ├── s3.json
│ └── lambda.json
├── profile-2/
│ └── services/
│ ├── eks.json
│ ├── rds.json
│ └── cloudfront.json
- Professional Branding: Complete integration of official AWS service icons (59+ services)
- Theme Flexibility: Dark/light theme toggle with system preference detection
- Smart Navigation: Improved service name formatting with proper spacing ("Secrets Manager" style)
- Interactive Data Visualization: DetailSidebar and DataPopover components for enhanced data exploration
- Runtime Discovery: All data loading is dynamic - no static configurations
- Smart Filtering: Filter options automatically generated from actual resource data
- Real-time Insights: Live resource counts and status indicators
- Complete Regional Support: All AWS regions configured with us-east-1 and ap-south-1 as defaults
- Modern Frontend: React + TypeScript with Vite for optimal development experience
- Component Architecture: Reusable components with proper separation of concerns
- Performance: Optimized data loading and responsive UI design
- Enhanced Interactivity: Click-to-expand functionality and detailed resource views
- Project Overview - Complete project philosophy, goals, and development approach
- Business Requirements Document - Detailed business requirements and scope
- Functional Requirements Document - Technical specifications and features
- System Architecture Document - Architecture design and implementation details
- Data Contract Document - Data structures and contracts
- Non-Functional Requirements - Performance, security, and quality requirements
- Read the Project Overview to understand our philosophy
- Check existing documentation for context
- Submit issues for bugs or feature requests
- Follow the development approach outlined in our planning documents
For questions or issues:
- Check the documentation files listed above
- Review the troubleshooting section in this README
- Submit an issue with detailed information about your setup and the problem
FinLens is built to last, be trusted, and help people think clearly about complex systems.