Skip to content

Installation & Quick Start

Installation Methods

The fastest way to get started. Pre-compiled binaries are available for Linux, macOS, and Windows.

Linux/macOS:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Verdenroz/finance-query/releases/latest/download/finance-query-cli-installer.sh | sh

Windows (PowerShell):

powershell -c "irm https://github.com/Verdenroz/finance-query/releases/latest/download/finance-query-cli-installer.ps1 | iex"

macOS (Homebrew):

brew install verdenroz/tap/fq

From Cargo

Install from crates.io (requires Rust):

cargo install finance-query-cli

From Source

Build from source:

git clone https://github.com/Verdenroz/finance-query
cd finance-query/finance-query-cli
cargo install --path .

Verify Installation

fq --version

Quick Start

Get a stock quote:

fq quote AAPL

View multiple quotes:

fq quote AAPL MSFT GOOGL TSLA

Stream live prices:

fq stream AAPL TSLA

View an interactive chart:

fq chart AAPL

Launch the dashboard:

fq dashboard

For detailed help, run:

fq --help
fq <command> --help

Data Storage

The CLI stores alerts, watchlists, and configuration in:

  • Linux/macOS: ~/.local/share/fq/
  • Windows: %APPDATA%\fq\