MarketDeck docs

Overview

MarketDeck CLI documentation — what it is, how it fits together, and where to look first.

MarketDeck is a CLI-first toolkit for Hyperliquid. Every piece of business logic — market snapshots, paper trading, AI agents, real wallet execution, backtesting, trailing stops — is a marketdeck subcommand you can run from a terminal, pipe through jq, or schedule with cron. The GNOME Shell extension and the self-hosted web UI are presentation layers that consume the same CLI.

These docs are organised the same way:

  • Get started — the shortest path from "git clone" to a working install.
  • Install — the long form for each platform.
  • CLI reference — one page per top-level command (snapshot, paper, agent, wallets, …) with verified flags and examples.
  • Plugins — how the GNOME extension and the web UI consume the CLI, and how to write your own plugin.
  • Architecture — why the CLI is the source of truth and what the daemon's narrow scope is.
  • Help — environment variables, troubleshooting, and the marketdeck doctor checks.

What you need#

  • Node.js 20 or newer.
  • A Linux desktop with gnome-keyring if you want the GNOME plugin or want libsecret-backed wallet storage. Without it the Node-side AES-GCM vault is the fallback.
  • A Hyperliquid wallet — paper-only flows work without one.

Three-line quick start#

git clone https://git.marketdeck.io/marketdeck/marketdeck
cd marketdeck && npm install && npm link
marketdeck doctor

marketdeck doctor walks the environment and reports per-line on each prerequisite — Node, sqlite, daemon socket, libsecret bridge, keyring, gsettings, agent activity. Anything red there blocks the rest of the docs from working as written.

Output format#

Every command supports --format json|text. JSON is the default because plugins are the biggest consumer; pass --format text for human-friendly output on the terminal:

marketdeck snapshot BTC --format text

Reference#