mirror of
https://github.com/Cyrix126/gupaxx.git
synced 2024-11-16 15:27:46 +00:00
e8b1f007bd
Some checks failed
Audit / audit (push) Has been cancelled
CI / ci (macos-latest) (push) Has been cancelled
CI / ci (ubuntu-latest) (push) Has been cancelled
Rust / fmt (push) Has been cancelled
Rust / test (macos-latest) (push) Has been cancelled
Rust / test (ubuntu-latest) (push) Has been cancelled
Rust / typo (push) Has been cancelled
Rust / clippy (macos-latest) (push) Has been cancelled
Rust / clippy (ubuntu-latest) (push) Has been cancelled
Rust / check (macos-latest) (push) Has been cancelled
Rust / check (ubuntu-latest) (push) Has been cancelled
Rust / doc (macos-latest) (push) Has been cancelled
Rust / doc (ubuntu-latest) (push) Has been cancelled
Typo / typo (push) Has been cancelled
56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# Notes CLI
|
|
|
|
|
|
## Features
|
|
|
|
- fetch p2pool node stratum data
|
|
- start XMRig instance.
|
|
- stop with descriptive errors if p2pool/xmrig have issue at launch.
|
|
- output status of algo
|
|
- output on demand public stats
|
|
- output on demand account stats
|
|
|
|
## Launch args
|
|
- XVB token
|
|
- XMR address
|
|
- optional: hero
|
|
- optional: quiet algo
|
|
- optional: quiet xmrig
|
|
- optional: path of xmrig
|
|
- optional: path of p2pool or p2pool address:port
|
|
|
|
Example:
|
|
|
|
```
|
|
gupaxx --cli --token xxxxx --address xxxxx --hero --p2pool="127.0.0.1:3333" -t 8 -q --path-xmrig="/path/to/xmrig-binary"
|
|
```
|
|
|
|
## Commands
|
|
Possible input at runtime:
|
|
- all commands of xmrig: transfer the commands to the xmrig instance and return output.
|
|
- pubstats/ps: returns the stats of the public API.
|
|
- accountstats/as: returns the stats of your account.
|
|
- quit: quit the program, shutting down xmrig.
|
|
Example
|
|
|
|
```
|
|
as ↵
|
|
failures: 0
|
|
donated_last_hour: 0.00kH/s
|
|
donated_last_24_hours: 0.00kH/s
|
|
Round: VIP
|
|
You are not the winner
|
|
```
|
|
|
|
|
|
## Technical implementation
|
|
|
|
The cli args are managed by [clap](https://docs.rs/clap).
|
|
The code for managing current args from upstream will be replaced to use this crate.
|
|
|
|
The cli mode is enabled by passing the argument cli.
|
|
It will autostart xmrig/xvb processes.
|
|
p2pool process will be started if no address is given in args.
|
|
Otherwise, it will watch p2pool data and mine on it.
|
|
|
|
Each argument can be omitted if it's present in the state file.
|