Getting Started
Pick your path and install only what you need — Plug & Play, React + SDK, or the Python backend runtime.
Use this page as a routing guide: pick your path, install only what you need, then follow a focused read order.
Runtime requirements
Node.js 18+ is recommended for frontend packages. Python 3.10+ is recommended for the core runtime and Plug & Play examples.
Choose a path
Plug & Play (fastest)
Get one working market agent quickly with tools, flows, and sandboxed execution.
React app integration
Build UI with @jazzmine-ui/react and connect transport with @jazzmine-ui/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.
pip install jazzmine
pip install yfinance==0.2.66 pandas==2.2.3 numpy==2.1.3npm install @jazzmine-ui/react @jazzmine-ui/sdkpip install jazzmineRecommended read order
- Start with Plug & Play to run a full working example.
- Move to React Usage and SDK Quick Start for app integration.
- Then cover Core Configuration, Security Usage, and Logging Usage for production hardening.