Getting Started

Install

.md

Get Finny running locally in under two minutes.

Prerequisites

Finny requires Node.js 18+ installed on your system. Python 3 and yfinance are needed for backtesting with real market data.

Install

Install Finny globally via npm:

bash
npm i -g finny

First run

Launch the interactive CLI:

bash
finny

On first run, Finny guides you through setting up your API key and preferred AI provider. You can re-run the setup at any time with /init inside the CLI.

Backtesting prerequisites

Backtesting shells out to Python and uses yfinance for historical market data. Install it once:

bash
pip install yfinance
If commands fail with “python: command not found”

Make sure Python 3 is on your PATH. On macOS, install via Homebrew: brew install python.