committer

The committer command starts Fabric-X committer services and checks service health.

Environment Variables

All configuration settings can be overridden using environment variables. The variable name follows the pattern SC_<SERVICE>_<KEY>, where dots and dashes in the key are replaced with underscores. To override settings using environment variable YAML, set SC_<SERVICE>_YAML.

Service prefixes: SIDECAR, COORDINATOR, VERIFIER, VC, QUERY.

For example, start the sidecar service with endpoint localhost:8080:

SC_SIDECAR_SERVER_ENDPOINT=localhost:8080 committer start sidecar -c config.yaml

Or via YAML:

SC_SIDECAR_YAML=$(cat <<EOF
server:
  endpoint: localhost:8080
EOF) committer start sidecar -c config.yaml

committer

Fabric-X Committer.

Usage:
  Committer [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  healthcheck Check if a service is healthy.
  help        Help about any command
  start       Start a service.
  version     print Committer version

Flags:
  -h, --help   help for Committer

Use "Committer [command] --help" for more information about a command.

committer start

Start a service.

Usage:
  Committer start [command]

Available Commands:
  coordinator Starts Coordinator.
  query       Starts Query-Service.
  sidecar     Starts Sidecar.
  vc          Starts Validator-Committer.
  verifier    Starts Verifier.

Flags:
  -h, --help   help for start

Use "Committer start [command] --help" for more information about a command.

committer start sidecar

Starts Sidecar.

Usage:
  Committer start sidecar [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for sidecar

committer start coordinator

Starts Coordinator.

Usage:
  Committer start coordinator [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for coordinator

committer start verifier

Starts Verifier.

Usage:
  Committer start verifier [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for verifier

committer start vc

Starts Validator-Committer.

Usage:
  Committer start vc [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for vc

committer start query

Starts Query-Service.

Usage:
  Committer start query [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for query

committer healthcheck

Check if a service is healthy.

Usage:
  Committer healthcheck [command]

Available Commands:
  coordinator Check Coordinator health.
  query       Check Query-Service health.
  sidecar     Check Sidecar health.
  vc          Check Validator-Committer health.
  verifier    Check Verifier health.

Flags:
  -h, --help   help for healthcheck

Use "Committer healthcheck [command] --help" for more information about a command.

committer healthcheck sidecar

Check Sidecar health.

Usage:
  Committer healthcheck sidecar [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for sidecar

committer healthcheck coordinator

Check Coordinator health.

Usage:
  Committer healthcheck coordinator [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for coordinator

committer healthcheck verifier

Check Verifier health.

Usage:
  Committer healthcheck verifier [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for verifier

committer healthcheck vc

Check Validator-Committer health.

Usage:
  Committer healthcheck vc [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for vc

committer healthcheck query

Check Query-Service health.

Usage:
  Committer healthcheck query [flags]

Flags:
  -c, --config string   set the config file path
  -h, --help            help for query

committer version

print Committer version

Usage:
  Committer version [flags]

Flags:
  -h, --help   help for version