jarvise

Paper analytics for an intelligent crypto trader. Live submit exists but stays gated off (JARVISE_LIVE_TRADING=false) until the owner enables trade keys.

Repository: https://github.com/chatoe-norm/jarvise

How to run the shipped product day-to-day (CLI, VPS schedules, agent/MCP): docs/product-usage.md.

Quick start (Phase 1 — ingest + paper analyze)

One Typer entrypoint: jarvise (status / init / config / ingest / analyze). Paper ingest and analyze are delegated from that CLI; jarvise-ingest / jarvise-analyze remain compatibility aliases.

# Python 3.12 required (3.11+ ok; prefer 3.12)
py -3.12 -m venv .venv
.venv\Scripts\pip install -e ".[dev]"

.venv\Scripts\jarvise ingest --symbol BTCUSDT --timeframe 4h --limit 50 --skip-derivatives --json
.venv\Scripts\jarvise analyze --symbol BTCUSDT --timeframe 4h --json

On macOS/Linux: python3.12 -m venv .venv, then use .venv/bin/pip and .venv/bin/jarvise.

With CoinGlass:

$env:COINGLASS_API_KEY="..."
.venv\Scripts\jarvise ingest --symbol BTCUSDT --timeframe 4h --json

SQLite DB: data/analytics/jarvise.db (gitignored). Doctrine extract: data/analytics/.

On Windows, prefer .venv\Scripts\jarvise over bash bin/jarvise status — the bash shim and Typer CLI use separate state files.

Command Dashboard (local)

Owner UI is the Vite/React SPA under web/, served by FastAPI jarvise_web on :8080 (Home / Paper / Decisions / Exchange / Ops). Day-to-day paths: docs/product-usage.md.

.venv/bin/pip install -e ".[web]"
.venv/bin/python -m uvicorn jarvise_web.app:app --port 8080
# optional hot UI: cd web && npm install && npm run dev   # :5173 → proxies API

Validate and format

.venv/bin/pip install -e ".[dev]"
make hooks     # install pre-commit + pre-push hooks once
make format    # Ruff lint fixes, then Ruff formatting
make check     # format check + ruff + mypy + full pytest coverage gate

# Scoped Python loop (keeps lint/type checks, skips the repo-wide coverage gate)
./scripts/check.sh tests/test_db_upsert.py -q

# Frontend validation
cd web && npm ci && npm run build

scripts/check.sh automatically uses the active virtual environment or the repo-local .venv; shell activation is not required.

Windows (no bash): .venv\Scripts\ruff format --check src tests scripts, then .venv\Scripts\ruff check src tests scripts, .venv\Scripts\mypy, and .venv\Scripts\python -m pytest --cov=src --cov-report=term --cov-fail-under=70.

Background MCP plane (Phase 2)

cp .env.example .env   # set N8N_BASIC_AUTH_PASSWORD, etc.
docker compose up -d
docker compose ps

# Doctrine RAG into Qdrant
.venv/bin/pip install -e '.[rag]'
.venv/bin/python scripts/rag_index_doctrine.py --query "expectancy FLAT"

# Host cron / n8n helper (writes Redis jarvise:ingest:last)
chmod +x infra/n8n/run-ingest-host.sh
./infra/n8n/run-ingest-host.sh