docs/Cli/Overview

CLI Overview

The subway command-line tool.

subway <command> [options]

Commands#

CommandDescription
subway agentStart a named agent connected to the mesh
subway sendSend a one-shot message to a named agent
subway broadcastBroadcast a message to a topic
subway bridgeStart the REST + WebSocket bridge server

Global options#

All commands accept --relay <host:port> to specify the relay. Default: relay.subway.dev:9000.

Quick examples#

# Start an agent
subway agent --name worker.relay
 
# Send a message
subway send worker.relay "hello"
 
# Broadcast to a topic
subway broadcast metrics.cpu "usage: 42%"
 
# Start a bridge server
subway bridge --port 9002