CLI: necter-miner

necter-miner 1.0.0 — mine Necter projects on this device

Commands:
  init           Create the data dir, keys, wallet and config (prompts when interactive)
  run            Foreground daemon (what services execute)
  start          Start mining (starts the daemon in the background when none runs)
  stop           Stop mining; `--daemon` also exits the daemon
  status         Show status (--json)
  join           One-step setup: init + bind (embedded wallet) + faucet + subscribe + run
  leave          Unbond this device's subscription to a project (--project)
  withdraw       Withdraw released collateral (--project)
  subscriptions  List subscriptions (--json)
  bind           Bind this device to an owner wallet (--owner 0x… | --embedded)
  wallet         create [--recovery-phrase [--words 12|24]] | import [--recovery-phrase [--account-index N] [--passphrase]] | show | export
  payout         set <ADDRESS>
  policy         show | set key=value … (values parsed as JSON when possible)
  bench          Run the benchmark suite
  claims         Show claimable rewards; `--submit` claims them (gasless)
  faucet         Request testnet NECTA for the owner wallet
  ui             Open the dashboard, or: status | enable-remote [--domain D] [--port P] | disable-remote [--forget-password] | set-password | rotate-token
  service        install | uninstall
  logs           [-f] [--level L]
  update         [--check]
  version

init options: --network (default necter-testnet), --class phone|tablet|laptop|desktop|server, --wallet embedded|external (default embedded). join options: --project (required), --collateral (NECTA, decimal; default the project’s minimum), --payout, --no-run.

Global options

Option (env)
`--data-dir` (`NECTER_MINER_DATA_DIR`)	data directory (default: the platform location)
`--config`	config file (default `<data-dir>/miner.toml`)
`--rpc-url` (`NECTER_RPC_URL`)	Hub RPC URL
`--relay-url` (`NECTER_RELAY_URL`)	relay URL (default: derived from `--rpc-url`)
`--log-level`
`--ui-bind`, `--ui-port`	dashboard address(es), `addr:port[,addr:port]`
`--ui-public`	open the dashboard on all interfaces (TLS + password required)
`--ui-password-file` (`NECTER_UI_PASSWORD_FILE`)	dashboard password (first line; must not be group/world-readable)
`--ui-domain`	Let’s Encrypt certificate for this domain
`--ui-dir` (`NECTER_UI_DIR`)	static build of the dashboard UI
`--no-ui`	no dashboard listener
`--wallet-key-file` (`NECTER_WALLET_KEY_FILE`)	wallet data key file (headless hosts without a keychain)
`--non-interactive`	never prompt

Data directory

Platform	Default
Linux	`~/.local/share/necter-miner`; as a service `/var/lib/necter-miner`
macOS	`~/Library/Application Support/network.necter.miner`
Windows	`%LOCALAPPDATA%\Necter\Miner` (service: `%PROGRAMDATA%\Necter\Miner`)

Contents: miner.toml, node.key (device identity), wallet.json (encrypted), ui.token (local API token), miner.db, modules/ (verified module cache), logs/, miner.lock.

Local API

The dashboard listener also serves a JSON API at /api/v1/* for scripts on the same machine: Authorization: Bearer $(cat <data_dir>/ui.token) (loopback only). /rpc/* proxies the Hub.

Exit codes

0 ok · 1 runtime error · 2 usage · 73 cannot create data dir or key · 75 another instance holds miner.lock · 78 configuration refused.