2017-04-15 06:02:08 +00:00
# XMRig
2018-03-14 18:32:09 +00:00
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
2018-02-18 21:17:50 +00:00
Use [config.xmrig.com ](https://config.xmrig.com/xmrig ) to generate, edit or share configurations.
2017-07-02 19:21:29 +00:00
2017-04-15 06:02:08 +00:00
### Options
```
2018-10-08 18:32:07 +00:00
-a, --algo=ALGO specify the algorithm to use
cryptonight
cryptonight-lite
cryptonight-heavy
2018-01-07 14:36:49 +00:00
-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
2018-10-08 18:32:07 +00:00
--rig-id=ID rig identifier for pool-side statistics (needs pool support)
2018-01-07 14:36:49 +00:00
-t, --threads=N number of miner threads
-v, --av=N algorithm variation, 0 auto select
2018-10-08 18:32:07 +00:00
-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
2018-01-07 14:36:49 +00:00
-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
2018-03-24 06:04:04 +00:00
--variant algorithm PoW variant
2018-01-07 14:36:49 +00:00
--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
2018-03-24 06:04:04 +00:00
-S, --syslog use system log for output messages
2018-01-07 14:36:49 +00:00
--max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75)
--safe safe adjust threads and av settings for current CPU
2018-10-08 18:32:07 +00:00
--asm=ASM ASM code for cn/2, possible values: auto, none, intel, ryzen.
2018-01-07 14:36:49 +00:00
--print-time=N print hashrate report every N seconds
--api-port=N port for the miner API
--api-access-token=T access token for API
--api-worker-id=ID custom worker-id for API
2018-10-08 18:32:07 +00:00
--api-id=ID custom instance ID for API
--api-ipv6 enable IPv6 support for API
--api-no-restricted enable full remote access (only if API token set)
--dry-run test configuration and exit
2018-01-07 14:36:49 +00:00
-h, --help display this help and exit
-V, --version output version information and exit
2017-04-15 06:02:08 +00:00
```
2018-10-08 18:32:07 +00:00
Also you can use configuration via config file, default name **config.json** . Some options available only via config file: [`autosave` ](https://github.com/xmrig/xmrig/issues/767 ), [`hw-aes` ](https://github.com/xmrig/xmrig/issues/563 ). `watch` option currently not implemented in miners only in proxy.
2017-08-18 03:47:51 +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 )
