2017-04-15 06:02:08 +00:00
# XMRig
2018-03-14 18:32:09 +00:00
2019-09-28 21:10:38 +00:00
**:warning: [Monero will change PoW algorithm to RandomX on November 30. ](https://github.com/xmrig/xmrig/issues/1204 )**
2018-02-01 22:14:39 +00:00
[](https://github.com/xmrig/xmrig/releases)
2018-02-01 22:58:11 +00:00
[](https://github.com/xmrig/xmrig/releases)
[](https://github.com/xmrig/xmrig/releases)
2018-02-01 22:14:39 +00:00
[](https://github.com/xmrig/xmrig/blob/master/LICENSE)
[](https://github.com/xmrig/xmrig/stargazers)
[](https://github.com/xmrig/xmrig/network)
2019-08-09 13:09:00 +00:00
XMRig is a high performance RandomX and CryptoNight CPU miner, with official support for Windows.
2017-04-15 06:02:08 +00:00
2017-11-02 00:37:58 +00:00
* This is the **CPU-mining** version, there is also a [NVIDIA GPU version ](https://github.com/xmrig/xmrig-nvidia ) and [AMD GPU version ]( https://github.com/xmrig/xmrig-amd ).
2017-08-20 06:48:31 +00:00
2019-08-09 12:44:33 +00:00
< img src = "doc/screenshot.png" width = "808" >
2017-04-15 06:56:09 +00:00
2017-04-15 06:02:08 +00:00
#### Table of contents
* [Download ](#download )
* [Usage ](#usage )
2017-06-14 13:49:47 +00:00
* [Build ](https://github.com/xmrig/xmrig/wiki/Build )
2017-05-13 17:31:27 +00:00
* [Donations ](#donations )
* [Contacts ](#contacts )
2017-04-15 06:02:08 +00:00
## Download
* Binary releases: https://github.com/xmrig/xmrig/releases
* Git tree: https://github.com/xmrig/xmrig.git
2017-08-18 03:47:51 +00:00
* Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions ](https://github.com/xmrig/xmrig/wiki/Build ).
2017-04-15 06:02:08 +00:00
## Usage
2019-09-20 20:06:38 +00:00
The preferred way to configure the miner is the [JSON config file ](src/config.json ) as it is more flexible and human friendly. The command line interface does not cover all features, such as mining profiles for different algorithms. Important options can be changed during runtime without miner restart by editing the config file or executing API calls.
2017-07-02 19:21:29 +00:00
2017-04-15 06:02:08 +00:00
### Options
```
2019-08-10 07:57:02 +00:00
-a, --algo=ALGO specify the algorithm to use
cn/r, cn/2, cn/1, cn/0, cn/double, cn/half, cn/fast,
cn/rwz, cn/zls, cn/xao, cn/rto, cn/gpu,
cn-lite/1,
cn-heavy/xhv, cn-heavy/tube, cn-heavy/0,
cn-pico,
rx/wow, rx/loki
-o, --url=URL URL of mining server
-O, --userpass=U:P username:password pair for mining server
-u, --user=USERNAME username for mining server
-p, --pass=PASSWORD password for mining server
--rig-id=ID rig identifier for pool-side statistics (needs pool support)
-t, --threads=N number of miner threads
-v, --av=N algorithm variation, 0 auto select
-k, --keepalive send keepalived packet for prevent timeout (needs pool support)
--nicehash enable nicehash.com support
--tls enable SSL/TLS support (needs pool support)
--tls-fingerprint=F pool TLS certificate fingerprint, if set enable strict certificate pinning
--daemon use daemon RPC instead of pool for solo mining
--daemon-poll-interval=N daemon poll interval in milliseconds (default: 1000)
-r, --retries=N number of times to retry before switch to backup server (default: 5)
-R, --retry-pause=N time to pause between retries (default: 5)
--cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
--cpu-priority set process priority (0 idle, 2 normal to 5 highest)
--no-huge-pages disable huge pages support
--no-color disable colored output
--donate-level=N donate level, default 5% (5 minutes in 100 minutes)
--user-agent set custom user-agent string for pool
-B, --background run the miner in the background
-c, --config=FILE load a JSON-format configuration file
-l, --log-file=FILE log all output to a file
--asm=ASM ASM optimizations, possible values: auto, none, intel, ryzen, bulldozer.
--print-time=N print hashrate report every N seconds
--api-worker-id=ID custom worker-id for API
--api-id=ID custom instance ID for API
--http-enabled enable HTTP API
--http-host=HOST bind host for HTTP API (default: 127.0.0.1)
--http-port=N bind port for HTTP API
--http-access-token=T access token for HTTP API
--http-no-restricted enable full remote access to HTTP API (only if access token set)
--randomx-init=N threads count to initialize RandomX dataset
--randomx-no-numa disable NUMA support for RandomX
--export-topology export hwloc topology to a XML file and exit
--dry-run test configuration and exit
-h, --help display this help and exit
-V, --version output version information and exit
2017-04-15 06:02:08 +00:00
```
2017-04-15 06:46:16 +00:00
## Donations
2019-08-09 13:09:00 +00:00
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code.
2017-04-15 06:46:16 +00:00
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
2017-04-15 06:56:09 +00:00
* BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
2017-04-21 09:34:59 +00:00
## Contacts
* support@xmrig.com
* [reddit ](https://www.reddit.com/user/XMRig/ )
2018-10-01 10:36:03 +00:00
* [twitter ](https://twitter.com/xmrig_dev )
