Skip to content

QUICKSTART.md

Latest commit

 

History

History
100 lines (75 loc) · 2.92 KB

QUICKSTART.md

File metadata and controls

100 lines (75 loc) · 2.92 KB
Raw

Hyperlex Quickstart

Hermes skill backed by this Python package repo. Full guide: README.md · docs/operator-loop.md.

Offline first success (no API keys)

From this repo — no Hermes host required:

python3 scripts/hyperlex.py demo

Expect ok: true, a receipt path, lineage for known slang (e.g. rizz → brainrot-aura), and brier: null.

Docs: docs/start/quickstart.md · See it work · Glossary

Committed sample: examples/quickstart/

Install (Hermes skill)

bash install.sh
export HERMES_SKILL_DIR="${HOME}/.hermes/skills/hyperlex"
export HLX="python3 $HERMES_SKILL_DIR/scripts/hyperlex.py"
$HLX check && $HLX smoke && $HLX demo
$HLX wizard --auto
$HLX commands

Claude Code

bash install.sh --claude
export HYPERLEX_SKILL_DIR="${HOME}/.claude/skills/hyperlex"
export HLX="python3 $HYPERLEX_SKILL_DIR/scripts/hyperlex.py"
$HLX demo
$HLX wizard --auto

Personal skill path: ~/.claude/skills/hyperlex. Plugin path: ~/.claude/plugins/hyperlex (--claude-plugin). Project helpers live under .claude/skills/. Settlement stays a human step. Guide: docs/claude-skill.md.

Daily path

# One-shot: analyze + receipt + forecasts + score log (offline-safe)
$HLX run "rizz" --route offline
$HLX run "locked in" --route offline

# Open forecasts → settle → Brier series
$HLX pending
$HLX settle --forecast-id <id> --decision TRUE
$HLX score-series --mean-shift --verify-chain

Ingest routes

$HLX sources
$HLX run "…" --route offline   # mock (default for first success)
$HLX run "…" --route live      # combined (needs network)
$HLX run "…" --route glossary
$HLX run "…" --route social
# Force mock for any route:
export HYPERLEX_OFFLINE=1

Scan + advisory cron

$HLX scan --config "$HERMES_SKILL_DIR/examples/cron/scan-queries.json" \
  --route offline --receipt --forecasts --append-log

$HLX risk-schedule --tier MODERATE --schedule-out /tmp/hlx-cron

Library

from hyperlex import (
    detect_memetic_patterns, extract_forecasts, emit_receipt,
    settle_and_log, recompute_series, pick_source,
)
from hyperlex.compat.abraxas import to_brier_ledger_entry, list_hlx_runes

src, _ = pick_source(route="offline")
result = detect_memetic_patterns("sharp steam", ingest_source=src, ingest_route="offline")
assert result["provenance"]["brier"] is None
emit_receipt(result)

Docs