XMRIG(1)

📦
version 6.26.0 · 5 versions
, in ubuntu stonking

💖 NAME 💖

XMRig — a CPU/GPU cryptocurrency miner. yeah bestie, we're literally mining crypto with our own silicon, it's giving main character energy ⛏️✨

🌈 SYNOPSIS 🌈

xmrig [OPTIONS]

that's it. that's the whole vibe. drop in some options and she goes 🚀

🦋 DESCRIPTION 🦋

okay so like, XMRig has so many options and they're all organized into little categories, so let's do a tour together bestie, no skimming, we do this properly 💅

🌐 Network 🌐

the "how do I actually talk to a pool" section, extremely important, lowkey the whole point 🫶

  • -o, --url=URL — the URL of the mining server. your pool's address, your destiny, your home 🏠
  • -a, --algo=ALGO — which mining algorithm to use. full list lives at https://xmrig.com/docs/algorithms — go peek, it's iconic
  • --coin=COIN — specify a coin instead of an algorithm. like, just tell her the coin and she figures the rest out 💅
  • -u, --user=USERNAME — your username on the mining server
  • -p, --pass=PASSWORD — your password on the mining server
  • -O, --userpass=U:P — the username:password pair, both at once, efficiency queen 👑
  • -x, --proxy=HOST:PORT — connect through a SOCKS5 proxy
  • -k, --keepalive — send a keepalived packet so you don't get timed out. heads up, this needs pool support to do anything
  • --nicehash — enable nicehash.com support
  • --rig-id=ID — rig identifier for pool-side statistics. also needs pool support
  • --tls — enable SSL/TLS support. yup, needs pool support
  • --tls-fingerprint=HEX — pool TLS certificate fingerprint, for strict certificate pinning. paranoia but make it ✨secure✨
  • -4, --ipv4 — resolve names to IPv4 addresses
  • -6, --ipv6 — resolve names to IPv6 addresses
  • --dns-ttl=N — TTL for the internal DNS cache, in seconds. default is 30
  • --daemon — use daemon RPC instead of a pool, for solo mining. solo queen behavior 💀
  • --daemon-zmq-port=N — the daemon's zmq-pub port number. only use this if the daemon actually has it enabled, otherwise she's just gonna sit there confused
  • --daemon-poll-interval=N — daemon poll interval in milliseconds. default: 1000
  • --daemon-job-timeout=N — daemon job timeout in milliseconds. default: 15000
  • --self-select=URL — self-select block templates from a URL
  • --submit-to-origin — also submit the solution back to the self-select URL
  • -r, --retries=N — how many times to retry before switching to the backup server. default: 5
  • -R, --retry-pause=N — how long to pause between retries. default: 5
  • --user-agent — set a custom user-agent string for the pool
  • --donate-level=N — the donate level, default 1% (that's 1 minute out of 100 minutes, bestie, she's not greedy 🥺)
  • --donate-over-proxy=N — control the donate over xmrig-proxy feature

🧠 CPU backend 🧠

the part where your processor earns its keep. very demure, very mindful, very hot 🔥

  • --no-cpu — disable the CPU mining backend entirely
  • -t, --threads=N — number of CPU threads. ngl, proper CPU affinity is required for some optimizations, so don't skip that
  • --cpu-affinity=N — set process affinity to CPU core(s). mask 0x3 means cores 0 and 1 🎯
  • -v, --av=N — algorithm variation. 0 means auto select
  • --cpu-priority=N — set process priority. 0 is idle, 2 is normal, up to 5 which is highest
  • --cpu-max-threads-hint=N — hint for autoconfig telling it the maximum CPU threads count, as a percentage
  • --cpu-memory-pool=N — number of 2 MB pages for the persistent memory pool. -1 is auto, 0 disables it
  • --cpu-no-yield — prefer maximum hashrate over system response/stability. yeah she's gonna hog the machine, that's the point 💀
  • --no-huge-pages — disable huge pages support
  • --hugepage-size=N — custom hugepage size in kB
  • --huge-pages-jit — enable huge pages support for RandomX JIT code
  • --asm=ASM — ASM optimizations. possible values: auto, none, intel, ryzen, bulldozer
  • --argon2-impl=IMPL — argon2 implementation. options: x86_64, SSE2, SSSE3, XOP, AVX2, AVX-512F
  • --randomx-init=N — threads count to initialize the RandomX dataset
  • --randomx-no-numa — disable NUMA support for RandomX
  • --randomx-mode=MODE — RandomX mode: auto, fast, light
  • --randomx-1gb-pages — use 1GB hugepages for the RandomX dataset. Linux only, bestie, sorry to the Windows girlies 🐧
  • --randomx-wrmsr=N — write custom value(s) to MSR registers, or disable the MSR mod with -1
  • --randomx-no-rdmsr — disable reverting the initial MSR values on exit
  • --randomx-cache-qos — enable Cache QoS

🌸 OpenCL backend 🌸

for when you want your GPU in on the action, it's giving graphics card glow-up 🎀

  • --opencl — enable the OpenCL mining backend
  • --opencl-devices=N — comma separated list of OpenCL devices to use
  • --opencl-platform=N — OpenCL platform index or name
  • --opencl-loader=PATH — path to the OpenCL-ICD-Loader (OpenCL.dll or libOpenCL.so)
  • --opencl-no-cache — disable the OpenCL cache
  • --print-platforms — print the available OpenCL platforms and exit. a little sneak peek, then she's gone 🙈

💜 CUDA backend 💜

NVIDIA girlies this one's for you, the green team ate 🌈

  • --cuda — enable the CUDA mining backend
  • --cuda-loader=PATH — path to the CUDA plugin (xmrig-cuda.dll or libxmrig-cuda.so)
  • --cuda-devices=N — comma separated list of CUDA devices to use
  • --cuda-bfactor-hint=N — bfactor hint for autoconfig, between 0 and 12
  • --cuda-bsleep-hint=N — bsleep hint for autoconfig
  • --no-nvml — disable NVML (NVIDIA Management Library) support

🛰️ API 🛰️

so other things can talk to your miner. networking but make it gossip 🫶

  • --api-worker-id=ID — custom worker-id for the API
  • --api-id=ID — custom instance ID for the API
  • --http-host=HOST — bind host for the HTTP API. default: 127.0.0.1
  • --http-port=N — bind port for the HTTP API
  • --http-access-token=T — access token for the HTTP API
  • --http-no-restricted — enable full remote access to the HTTP API. only if an access token is set, bestie, do not play with this one ⚠️

🔐 TLS 🔐

certificates and ciphers, very serious, very grown-up, very secure ✨

  • --tls-gen=HOSTNAME — generate a TLS certificate for a specific hostname
  • --tls-cert=FILE — load the TLS certificate chain from a file in the PEM format
  • --tls-cert-key=FILE — load the TLS certificate private key from a file in the PEM format
  • --tls-dhparam=FILE — load DH parameters for DHE ciphers from a file in the PEM format
  • --tls-protocols=N — enable specified TLS protocols. example: "TLSv1 TLSv1.1 TLSv1.2 TLSv1.3"
  • --tls-ciphers=S — set the list of available ciphers (TLSv1.2 and below)
  • --tls-ciphersuites=S — set the list of available TLSv1.3 ciphersuites

📝 Logging 📝

the receipts, the lore, the documentation of what your rig has been up to 💅

  • -S, --syslog — use the system log for output messages
  • -l, --log-file=FILE — log all output to a file
  • --print-time=N — print a hashrate report every N seconds
  • --health-print-time=N — print a health report every N seconds
  • --no-color — disable colored output. (why would you, it's so pretty, but ok 🥲)
  • --verbose — verbose output

🎀 Misc 🎀

the grab bag, the everything-else drawer, the bits and bobs 🍓

  • -c, --config=FILE — load a JSON-format configuration file
  • -B, --background — run the miner in the background
  • -V, --version — output version information and exit
  • -h, --help — display this help and exit
  • --dry-run — test the configuration and exit
  • --export-topology — export the hwloc topology to a XML file and exit
  • --pause-on-battery — pause mining on battery power
  • --pause-on-active=N — pause mining when the user is active, and resume after N seconds of last activity
  • --stress — run a continuous stress test to check system stability. it's literally just stress, no cap 😤
  • --bench=N — run a benchmark. N can be between 1M and 10M
  • --submit — perform an online benchmark and submit the result for sharing
  • --verify=ID — verify a submitted benchmark by ID
  • --seed=SEED — custom RandomX seed for the benchmark
  • --hash=HASH — compare the benchmark result with a specified hash
  • --no-dmi — disable the DMI/SMBIOS reader

and then she hits you with the build receipts:

features: 64-bit AES

libuv/1.52.1 OpenSSL/4.0.1 hwloc/2.14.0

🫶 SEE ALSO 🫶

The full documentation for XMRig is maintained as a Texinfo manual. If the info and XMRig programs are properly installed at your site, the command

info XMRig

should give you access to the complete manual. she has a whole manual, bestie, she's not just a one-page girlie 📖💖

that's the tea, the whole page, every single flag, nothing skipped because we don't do half-effort around here 💅 this was XMRig 6.26.0 built with GCC 15.3.0, from August 2026, living under the User Commands banner as XMRIG(1) — now go mine something gorgeous, mwah 😘👑

📦 where this page comes from