Mining/site-docs/cli/commands.md

CLI Commands

Complete reference for the miner-ctrl command-line interface.

Global Flags

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.

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:

# 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.

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:

# 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.

miner-ctrl stop <miner-name>

Examples:

# Stop a specific miner
miner-ctrl stop xmrig-123

# Stop all miners
miner-ctrl stop --all

---

status

Show status of running miners.

miner-ctrl status [miner-name]

Examples:

# 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.

miner-ctrl list [flags]

Flag	Description
--available	Show available miners
--running	Show running miners
--installed	Show installed miners

---

install

Install a miner.

miner-ctrl install <miner-type>

Examples:

miner-ctrl install xmrig
miner-ctrl install tt-miner

---

uninstall

Uninstall a miner.

miner-ctrl uninstall <miner-type>

---

update

Update a miner to the latest version.

miner-ctrl update <miner-type>

---

doctor

Check system health and miner installations.

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.

miner-ctrl node init [flags]

Flag	Description
--name	Node name
--role	Role (controller/worker/dual)

node info

Show node information.

miner-ctrl node info

node serve

Start P2P server.

miner-ctrl node serve [flags]

Flag	Default	Description
--listen	:9091	Listen address

---

peer

Peer management commands.

peer add

Add a peer node.

miner-ctrl peer add [flags]

Flag	Description
--address	Peer address (host:port)
--name	Peer name

peer list

List registered peers.

miner-ctrl peer list

peer remove

Remove a peer.

miner-ctrl peer remove <peer-id>

peer ping

Ping a peer.

miner-ctrl peer ping <peer-id>

---

remote

Remote miner operations.

remote status

Get stats from remote peers.

miner-ctrl remote status [peer-id]

remote start

Start miner on remote peer.

miner-ctrl remote start <peer-id> --profile <profile-id>

remote stop

Stop miner on remote peer.

miner-ctrl remote stop <peer-id> [miner-name]

remote logs

Get logs from remote miner.

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.

miner-ctrl profile list

profile create

Create a new profile.

miner-ctrl profile create [flags]

profile delete

Delete a profile.

miner-ctrl profile delete <profile-id>