Jazzmine logo
Plug & PlayStart GuideGitHub
Start here
Docs map

Getting Started

Use this page as a routing guide: pick your path, install only what you need, then follow a focused read order.

Choose a path

Runtime requirements

Node.js 18+ is recommended for frontend packages. Python 3.10+ is recommended for core runtime and Plug & Play examples.

Plug & Play (fastest)

Get one working market agent quickly with tools, flows, and sandboxed execution.

React app integration

Build UI with jazzmine-react and connect transport with jazzmine-sdk.

Backend runtime

Set up jazzmine with logging and security middleware for production services.

Install by path

Avoid installing everything by default. Install the minimum set for your current goal.

Plug & Play path

install.sh
pip install jazzmine
pip install yfinance==0.2.66 pandas==2.2.3 numpy==2.1.3

React + SDK path

install.sh
npm install jazzmine-react jazzmine-sdk

Backend runtime path

install.sh
pip install jazzmine