SPB Git forge

spb/hfmarketdata

Public

Open high-frequency market data platform — FirstRate full-history downloader, DuckDB/Parquet lake, open REST API and React docs platform (www.hfmarketdata.io)

127commits 1branches 0releases
24.7 MBsize
maindefault branch
11 days agolast push
JavaScript 53.7% Python 38.3% CSS 4.6% TypeScript 3.1%
1.8 KB · 55 lines markdown
Rendered Raw Blame History
1# Recording `docs/demo.gif`23The README and the Integrations page reference `mcp/docs/demo.gif` (also copied to4`hfmarketdata/web/public/downloads/mcp-demo.gif` when it exists). It is not committed yet — record it like this.56## Setup (once)78```bash9brew install vhs            # charmbracelet/vhs: scripted terminal recordings → GIF10cd mcp && npm run build && npm i -g ./$(npm pack --silent)11claude mcp add hfmarketdata -e HFMD_API_KEY=$HFMD_API_KEY -- hfmarketdata-mcp12```1314## Script — `scripts/demo.tape`1516```tape17Output docs/demo.gif18Set Theme "Catppuccin Mocha"19Set FontSize 1520Set Width 124021Set Height 72022Set TypingSpeed 40ms2324Type "claude"25Enter26Sleep 3s27Type "Plot me the CL term structure as an ASCII chart and tell me if it is in contango"28Enter29Sleep 18s30Type "Compare ESZ25 and ESH26 over 30 days"31Enter32Sleep 18s33Type "Screen US stocks with PE<15 and FCF yield>6% and show their last 3 quarters"34Enter35Sleep 20s36Ctrl+C37```3839```bash40vhs scripts/demo.tape        # writes docs/demo.gif (~4-8 MB; keep it under 10 MB — lower Width or Sleep if needed)41```4243## Manual alternative44451. `QuickTime Player → File → New Screen Recording`, select the terminal window (1240×720 px area).462. Run the three prompts above in Claude Code with the `hfmarketdata` server enabled.473. Convert: `ffmpeg -i demo.mov -vf "fps=12,scale=1240:-1:flags=lanczos" -loop 0 docs/demo.gif` (or `gifski --fps 12 --width 1240 -o docs/demo.gif demo.mov`).4849## Checklist before committing the GIF5051- No API key visible (use `HFMD_API_KEY=…` from the environment, never typed on screen).52- Shows at least one tool call line (`get_term_structure`, `get_bars`) and one result table.53- < 10 MB; first frame readable (the GIF is the README hero).54- Copy to `hfmarketdata/web/public/downloads/mcp-demo.gif` so the Integrations page can display it without external CDNs.55