Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/docs/CLI.md
google-labs-jules[bot] 960ae087fa Add descriptive markdown documentation to docs folder 
Added comprehensive documentation including:
- API.md: REST API reference.
- CLI.md: Command Line Interface usage.
- ARCHITECTURE.md: System design and components.
- DEVELOPMENT.md: Developer guide.
- README.md: Index for the documentation.
2025-11-25 00:03:35 +00:00

1.6 KiB
Raw Blame History

Mining CLI Documentation

The miner-cli 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-cli 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-cli start [miner-type] [flags]

stop

Stop a running miner.

Usage:

miner-cli stop [miner-name]

status

Get status of a running miner.

Usage:

miner-cli status [miner-name]

list

List running and available miners.

Usage:

miner-cli list

install

Install or update a miner.

Usage:

miner-cli install [miner-type]

uninstall

Uninstall a miner.

Usage:

miner-cli uninstall [miner-type]

update

Check for updates to installed miners.

Usage:

miner-cli update

doctor

Check and refresh the status of installed miners.

Usage:

miner-cli doctor

completion

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

Usage:

miner-cli completion [shell]