URGENT GAZA HUMANITARIAN EMERGENCY: Support vital civilian relief efforts directly through trusted global organizations.

Setup & Deployment

What are the system requirements to deploy CairnIQ?
CairnIQ runs on Windows, macOS, and Linux environments. You need:
• Python 3.10, 3.11, or 3.12.
• An active internet connection for API tickers synchronization and yfinance scans.
• Approximately 100MB of local storage space for logs, local configurations, and cache files.
How do I verify dependencies and start the local server?
Clone the repository, navigate to the folder, and run:
macOS & Linux:
git clone https://github.com/aymanyaq/cairniq.git
cd cairniq
./install.sh
./CairnIQ.command
Windows (Open PowerShell as Administrator in the project directory):
git clone https://github.com/aymanyaq/cairniq.git
cd cairniq
Set-ExecutionPolicy Bypass -Scope Process
.\install.ps1
.\CairnIQ.bat
This starts the local FastAPI server at `http://127.0.0.1:8000` and opens the terminal interface in your default browser.

Data Privacy & Security

Are my API keys saved in raw plaintext files?
No. Although keys can be initially added to a temporary `.env` file during onboarding, CairnIQ automatically runs a migration script that transfers those secrets into your OS system secure storage (Keychain on macOS, Secret Service on Linux) and removes them from disk. Subsequent accesses load them directly into memory from the keychain.
Does CairnIQ upload portfolio data to a remote cloud?
Never. Your portfolios, tickers history, custom investment journal notes, and LLM chat transcripts remain strictly inside the local user_data/ directory on your hard drive. The application contains no tracking trackers, analytics integrations, or telemetry.
How are LLM provider policies handled?
CairnIQ routes requests to enterprise developer endpoints (e.g. AWS Bedrock, Anthropic API, or OpenAI API). The terms of service for these developer-facing interfaces guarantee that prompts, logs, and data are never stored persistently or used to train foundation model parameters. Switch providers instantly via the local terminal interface.

Capabilities & Integrations

What brokerages can I connect?
CairnIQ natively supports direct API synchronization with popular brokers (e.g. Questrade, Alpaca). Additionally, you can upload standard CSV spreadsheets exports from any broker (Fidelity, Interactive Brokers, Vanguard, Schwab) directly. Overlapping positions are automatically merged and deduplicated.
Can I use CairnIQ for commercial advisory purposes?
No. CairnIQ is licensed strictly for personal, non-commercial use. Commercial use within hedge funds, registered investment advisors (RIAs), family offices, or paid newsletters is strictly prohibited.

Need Technical Assistance?

Open an issue on GitHub, check our codebase, or contact support directly.

Open GitHub Issue Email Support