69376b886f
Complete rebranding of all components: - Core miner: xmrig -> miner (binary, version.h, CMakeLists.txt) - Proxy: xmrig-proxy -> miner-proxy - CUDA plugin: xmrig-cuda -> miner-cuda - Heatmap: xmrig-nonces-heatmap -> miner-nonces-heatmap - Go CLI wrapper: miner-cli -> miner-ctrl Vendored XMRig ecosystem into miner/ directory: - miner/core - XMRig CPU/GPU miner - miner/proxy - Stratum proxy - miner/cuda - NVIDIA CUDA plugin - miner/heatmap - Nonce visualization tool - miner/config - Configuration UI - miner/deps - Pre-built dependencies Updated dev fee to use project wallet with opt-out (kMinimumDonateLevel=0) Updated branding to Lethean (domain, copyright, version 0.1.0) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
356 lines
4.6 KiB
Markdown
356 lines
4.6 KiB
Markdown
# CLI Commands
|
|
|
|
Complete reference for the `miner-ctrl` command-line interface.
|
|
|
|
## Global Flags
|
|
|
|
```bash
|
|
miner-ctrl [command] [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--help`, `-h` | Show help for command |
|
|
| `--version`, `-v` | Show version |
|
|
|
|
---
|
|
|
|
## serve
|
|
|
|
Start the REST API server and web dashboard.
|
|
|
|
```bash
|
|
miner-ctrl serve [flags]
|
|
```
|
|
|
|
| Flag | Default | Description |
|
|
|------|---------|-------------|
|
|
| `--port`, `-p` | 9090 | API server port |
|
|
| `--namespace`, `-n` | /api/v1/mining | API namespace |
|
|
| `--no-autostart` | false | Disable miner autostart |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Start with defaults
|
|
miner-ctrl serve
|
|
|
|
# Custom port
|
|
miner-ctrl serve --port 8080
|
|
|
|
# Disable autostart
|
|
miner-ctrl serve --no-autostart
|
|
```
|
|
|
|
---
|
|
|
|
## start
|
|
|
|
Start a miner with a specific configuration.
|
|
|
|
```bash
|
|
miner-ctrl start <miner-type> [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--pool`, `-o` | Pool address |
|
|
| `--wallet`, `-u` | Wallet address |
|
|
| `--threads`, `-t` | CPU threads |
|
|
| `--tls` | Enable TLS |
|
|
| `--profile` | Use profile by name/ID |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Start XMRig with pool and wallet
|
|
miner-ctrl start xmrig --pool pool.example.com:3333 --wallet 4xxx...
|
|
|
|
# Start using a profile
|
|
miner-ctrl start --profile "My Profile"
|
|
|
|
# Start TT-Miner on specific GPUs
|
|
miner-ctrl start tt-miner --pool pool.example.com:4444 --devices 0,1
|
|
```
|
|
|
|
---
|
|
|
|
## stop
|
|
|
|
Stop a running miner.
|
|
|
|
```bash
|
|
miner-ctrl stop <miner-name>
|
|
```
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Stop a specific miner
|
|
miner-ctrl stop xmrig-123
|
|
|
|
# Stop all miners
|
|
miner-ctrl stop --all
|
|
```
|
|
|
|
---
|
|
|
|
## status
|
|
|
|
Show status of running miners.
|
|
|
|
```bash
|
|
miner-ctrl status [miner-name]
|
|
```
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Show all miners
|
|
miner-ctrl status
|
|
|
|
# Show specific miner
|
|
miner-ctrl status xmrig-123
|
|
```
|
|
|
|
**Output:**
|
|
```
|
|
NAME HASHRATE SHARES UPTIME POOL
|
|
xmrig-123 1.23 kH/s 42/43 1h 23m pool.example.com
|
|
```
|
|
|
|
---
|
|
|
|
## list
|
|
|
|
List available or running miners.
|
|
|
|
```bash
|
|
miner-ctrl list [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--available` | Show available miners |
|
|
| `--running` | Show running miners |
|
|
| `--installed` | Show installed miners |
|
|
|
|
---
|
|
|
|
## install
|
|
|
|
Install a miner.
|
|
|
|
```bash
|
|
miner-ctrl install <miner-type>
|
|
```
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
miner-ctrl install xmrig
|
|
miner-ctrl install tt-miner
|
|
```
|
|
|
|
---
|
|
|
|
## uninstall
|
|
|
|
Uninstall a miner.
|
|
|
|
```bash
|
|
miner-ctrl uninstall <miner-type>
|
|
```
|
|
|
|
---
|
|
|
|
## update
|
|
|
|
Update a miner to the latest version.
|
|
|
|
```bash
|
|
miner-ctrl update <miner-type>
|
|
```
|
|
|
|
---
|
|
|
|
## doctor
|
|
|
|
Check system health and miner installations.
|
|
|
|
```bash
|
|
miner-ctrl doctor
|
|
```
|
|
|
|
**Output:**
|
|
```
|
|
System Check
|
|
============
|
|
Platform: linux
|
|
CPU: AMD Ryzen 9 5950X
|
|
Cores: 32
|
|
Memory: 64 GB
|
|
|
|
Miner Status
|
|
============
|
|
✓ xmrig v6.25.0 installed
|
|
✗ tt-miner not installed
|
|
|
|
Recommendations
|
|
===============
|
|
- Enable huge pages for better performance
|
|
```
|
|
|
|
---
|
|
|
|
## node
|
|
|
|
P2P node management commands.
|
|
|
|
### node init
|
|
|
|
Initialize node identity.
|
|
|
|
```bash
|
|
miner-ctrl node init [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--name` | Node name |
|
|
| `--role` | Role (controller/worker/dual) |
|
|
|
|
### node info
|
|
|
|
Show node information.
|
|
|
|
```bash
|
|
miner-ctrl node info
|
|
```
|
|
|
|
### node serve
|
|
|
|
Start P2P server.
|
|
|
|
```bash
|
|
miner-ctrl node serve [flags]
|
|
```
|
|
|
|
| Flag | Default | Description |
|
|
|------|---------|-------------|
|
|
| `--listen` | :9091 | Listen address |
|
|
|
|
---
|
|
|
|
## peer
|
|
|
|
Peer management commands.
|
|
|
|
### peer add
|
|
|
|
Add a peer node.
|
|
|
|
```bash
|
|
miner-ctrl peer add [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--address` | Peer address (host:port) |
|
|
| `--name` | Peer name |
|
|
|
|
### peer list
|
|
|
|
List registered peers.
|
|
|
|
```bash
|
|
miner-ctrl peer list
|
|
```
|
|
|
|
### peer remove
|
|
|
|
Remove a peer.
|
|
|
|
```bash
|
|
miner-ctrl peer remove <peer-id>
|
|
```
|
|
|
|
### peer ping
|
|
|
|
Ping a peer.
|
|
|
|
```bash
|
|
miner-ctrl peer ping <peer-id>
|
|
```
|
|
|
|
---
|
|
|
|
## remote
|
|
|
|
Remote miner operations.
|
|
|
|
### remote status
|
|
|
|
Get stats from remote peers.
|
|
|
|
```bash
|
|
miner-ctrl remote status [peer-id]
|
|
```
|
|
|
|
### remote start
|
|
|
|
Start miner on remote peer.
|
|
|
|
```bash
|
|
miner-ctrl remote start <peer-id> --profile <profile-id>
|
|
```
|
|
|
|
### remote stop
|
|
|
|
Stop miner on remote peer.
|
|
|
|
```bash
|
|
miner-ctrl remote stop <peer-id> [miner-name]
|
|
```
|
|
|
|
### remote logs
|
|
|
|
Get logs from remote miner.
|
|
|
|
```bash
|
|
miner-ctrl remote logs <peer-id> <miner-name> [flags]
|
|
```
|
|
|
|
| Flag | Default | Description |
|
|
|------|---------|-------------|
|
|
| `--lines`, `-n` | 100 | Number of lines |
|
|
|
|
---
|
|
|
|
## profile
|
|
|
|
Profile management commands.
|
|
|
|
### profile list
|
|
|
|
List all profiles.
|
|
|
|
```bash
|
|
miner-ctrl profile list
|
|
```
|
|
|
|
### profile create
|
|
|
|
Create a new profile.
|
|
|
|
```bash
|
|
miner-ctrl profile create [flags]
|
|
```
|
|
|
|
### profile delete
|
|
|
|
Delete a profile.
|
|
|
|
```bash
|
|
miner-ctrl profile delete <profile-id>
|
|
```
|