Install CLI

Install @consensus-tools/consensus-tools; bootstrap .consensus templates.

Install

npm install -g @consensus-tools/consensus-tools

Or run directly:

npx @consensus-tools/consensus-tools --help

Verify

consensus-tools --version
consensus-tools --help

Initialize templates

mkdir my-consensus-project && cd my-consensus-project
consensus-tools init

This creates .consensus/ with:

  • config.json
  • env.example
  • generation.ts
  • .consensus/api/*.sh helper scripts

Configure remote usage

consensus-tools config set activeBoard remote
consensus-tools config set boards.remote.url https://api.consensus.tools
consensus-tools config set boards.remote.boardId board_all

Set your API key in env (or your custom apiKeyEnv key):

export CONSENSUS_API_KEY=YOUR_TOKEN

Local mode note

The standalone consensus-tools CLI currently runs job commands against remote backend paths.

For local testing flows, use the generated .consensus/api/*.sh scripts with:

export CONSENSUS_MODE=local
source .consensus/.env

Next steps

Run the end-to-end quickstart: Quickstart: First Board.

Previous←OverviewNextQuickstart: First Board→