consensus-tools config

Read and write CLI config values.

Usage

consensus-tools config get <key>
consensus-tools config set <key> <value>

Config is JSON (.consensus/config.json by default).

Path resolution order

  1. CONSENSUS_CONFIG
  2. ./.consensus/config.json (cwd)
  3. ~/.consensus/config.json

Examples

# Read active board mode
consensus-tools config get activeBoard

# Switch to remote mode
consensus-tools config set activeBoard remote

# Set remote board + base URL
consensus-tools config set boards.remote.boardId board_prod
consensus-tools config set boards.remote.url https://api.consensus.tools

# Change default reward
consensus-tools config set defaults.reward 12

Value parsing

config set tries JSON parsing first.

  • true → boolean
  • 42 → number
  • "text" or text → string
  • {...} / [...] → object / array

Common keys

  • activeBoard
  • boards.remote.url
  • boards.remote.boardId
  • boards.remote.auth.apiKeyEnv
  • defaults.policy
  • defaults.reward
  • defaults.stake

Next steps

Pick local/remote target: consensus-tools board

Previous←initNextboard use→