twitchdropsminer-cli
v0.6.2
Published
Headless CLI rewrite of DevilXD/TwitchDropsMiner for mining Twitch drops on servers.
Readme
TwitchDropsMiner-CLI
Headless, npm-installable CLI that mines Twitch Drops on a server. No browser, no video, no GPU.
Install
npm install -g twitchdropsminer-cli
tdm doctorFrom GitHub:
npm install -g github:vocino/TwitchDropsMiner-CLIFrom source:
git clone https://github.com/vocino/TwitchDropsMiner-CLI.git
cd TwitchDropsMiner-CLI
npm ci && npm run build
npx tdm doctorRequires Node >=22.14.0.
Use
tdm auth login --no-open # prints URL + code, enter on phone
tdm auth validate
tdm games # list games with active Drops
tdm games --add "Overwatch"
tdm run --verboseKeep alive:
tdm service install --user --autostart
tdm service start
tdm logs --followCheck progress:
tdm status
tdm drops
tdm history --summaryWhat this does
Inventory -> wanted games (priority) -> live channels per game -> pick channel -> minute-watched beacons to spade.twitch.tv -> PubSub + CurrentDrop in sync -> auto-claim 24h window. No video stream, ever.
Extra: calendar / optimize / simulate / rules for planning, hooks / export for homelab (ntfy, Discord, HA, Prometheus), watch for TUI.
Full docs in the wiki — that's the manual now.
Docs
All user docs live in the wiki: https://github.com/vocino/TwitchDropsMiner-CLI/wiki
- Start here: https://github.com/vocino/TwitchDropsMiner-CLI/wiki/Getting-Started
- Every command: https://github.com/vocino/TwitchDropsMiner-CLI/wiki/CLI-Reference
- Config, Service, Observability, Troubleshooting, Architecture — all in the wiki sidebar.
This README stays minimal on purpose. If wiki and README disagree, wiki wins.
What's inside
src/cli/ commands (run, auth, status, config, games, doctor, service, history, metrics, drops, watch, hooks/export, calendar/optimize/simulate, rules)
src/core/ miner, watchLoop 59s tick, channelService, stateMachine, maintenance
src/integrations/ gqlClient, gqlOperations 11 ops, twitchPubSub pool 8*50->199, twitchSpade beacon
src/domain/ inventory chains, channel
src/config/ zod schema, XDG store 600
src/state/ authStore, deviceStore, sessionState
examples/ glance-tdm-widget.ymlDevelop
npm test # tsc + node --test dist/tests/index.js
npm run buildWiki lives in its own git: https://github.com/vocino/TwitchDropsMiner-CLI.wiki.git (branch master). Edit it directly.
Credits
Original idea from DevilXD/TwitchDropsMiner. This is an independent TypeScript rewrite for headless server use — different codebase, same Drop-mining concept.
License MIT.
