Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/docs/CLI.md
snider 69376b886f feat: Rebrand xmrig to miner and vendor XMRig ecosystem 
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>
2025-12-30 19:43:02 +00:00

1.6 KiB
Raw Blame History

Mining CLI Documentation

The miner-ctrl is the command-line interface for the Mining project. It allows you to manage miners directly from the terminal or start a REST API server.

Installation

go install github.com/Snider/Mining/cmd/mining@latest

Global Flags

  • --config string: Config file (default is $HOME/.mining.yaml)
  • --help: Help for the command

Commands

serve

Starts the mining service and interactive shell.

Usage:

miner-ctrl serve [flags]

Flags:

  • --host: Host to listen on (default "0.0.0.0")
  • -p, --port: Port to listen on (default 8080)
  • -n, --namespace: API namespace for the swagger UI (default "/")

start

Start a new miner.

Usage:

miner-ctrl start [miner-type] [flags]

stop

Stop a running miner.

Usage:

miner-ctrl stop [miner-name]

status

Get status of a running miner.

Usage:

miner-ctrl status [miner-name]

list

List running and available miners.

Usage:

miner-ctrl list

install

Install or update a miner.

Usage:

miner-ctrl install [miner-type]

uninstall

Uninstall a miner.

Usage:

miner-ctrl uninstall [miner-type]

update

Check for updates to installed miners.

Usage:

miner-ctrl update

doctor

Check and refresh the status of installed miners.

Usage:

miner-ctrl doctor

completion

Generate the autocompletion script for the specified shell (bash, zsh, fish, powershell).

Usage:

miner-ctrl completion [shell]