CLI Examples

styx health

export STYX_SERVER=http://styx.example.com:8080
styx health

styx query node-1

node node-1:
  alive:   85.0%
  dead:    10.0%
  unknown: 5.0%
  status:  likely alive

styx report witness-1 target-node 0.9 0.05 0.05

styx report witness-1 target-node 0.1 0.85 0.05

styx report witness-1 target-node 0.2 0.2 0.6

while true; do
  styx query critical-node
  sleep 10
done

for node in node-1 node-2 node-3; do
  echo "Checking $node..."
  styx query $node
  echo ""
done

#!/bin/bash

if styx health > /dev/null 2>&1; then
  echo "Styx server is operational"
  exit 0
else
  echo "Alert: Styx server is down!"
  exit 1
fi

# Production environment
export STYX_SERVER=http://styx-prod.example.com:8080
styx query prod-node-1

# Staging environment
export STYX_SERVER=http://styx-staging.example.com:8080
styx query staging-node-1

# Local development
export STYX_SERVER=http://localhost:8080
styx query local-node-1

#!/bin/bash

TARGET="node-5"

# Witness 1 reports node as alive
styx report witness-1 $TARGET 0.9 0.05 0.05

# Witness 2 reports node as alive
styx report witness-2 $TARGET 0.85 0.1 0.05

# Witness 3 reports node as alive
styx report witness-3 $TARGET 0.95 0.03 0.02

# Query aggregated status
styx query $TARGET

#!/bin/bash

NODE_ID="important-node"

if ! styx health > /dev/null 2>&1; then
  echo "Error: Cannot connect to Styx server"
  exit 1
fi

if styx query $NODE_ID | grep -q "likely dead"; then
  echo "Alert: $NODE_ID appears to be dead!"
  # Trigger recovery procedures
  ./restart-node.sh $NODE_ID
fi

#!/bin/bash

OUTPUT=$(styx query node-1)
STATUS=$(echo "$OUTPUT" | grep "status:" | awk '{print $2}')

if [ "$STATUS" = "DEAD" ]; then
  echo "Node is confirmed dead"
elif [ "$STATUS" = "likely" ]; then
  echo "Node status is uncertain"
else
  echo "Node appears operational"
fi

# .github/workflows/deploy.yml
steps:
  - name: Check Styx Server
    run: |
      export STYX_SERVER=${{ secrets.STYX_SERVER }}
      if ! styx health; then
        echo "Styx server unhealthy, aborting deployment"
        exit 1
      fi

apiVersion: v1
kind: Pod
spec:
  containers:
  - name: app
    livenessProbe:
      exec:
        command:
        - /bin/sh
        - -c
        - styx health
      initialDelaySeconds: 30
      periodSeconds: 10

#!/bin/bash

NODE="$1"
OUTPUT=$(styx query $NODE)

ALIVE=$(echo "$OUTPUT" | grep "alive:" | awk '{print $2}' | tr -d '%')
DEAD=$(echo "$OUTPUT" | grep "dead:" | awk '{print $2}' | tr -d '%')

echo "styx_node_alive_confidence{node=\"$NODE\"} $ALIVE"
echo "styx_node_dead_confidence{node=\"$NODE\"} $DEAD"