Issue commands to the engine, or a node, by mentioning it.
You'll need to have administrator permissions for most commands. This is configured in the environment for each node.
| Keyword | Intent |
|---|---|
shutdown |
Shutdown the engine or node. |
Issue commands to the engine by mentioning it.
| Keyword | Intent |
|---|---|
shutdown |
Shutdown the engine or node. |
new |
Creates and starts a new game. |
status |
Reports on status. |
abandon |
Abandons a game. |
advance |
Advances a game. |
eg. @[email protected] shutdown
NB. As docker compose is currently configured to restart containers on error, and because the shutdown command causes an exception during shutdown, this command is currently ineffectual. The node or engine will restart immediately.
Initiates a new game, all named nodes will participate.
new MoveLock <title> <description> <shortcode> [<shortcode>] [<shortcode>]...
eg. @[email protected] new MoveLock "First" "The very first consensus chess game." node-prod-00
Reports on the general status (nodes and games) or a specific game.
status [<shortcode>]
eg. @[email protected] status
eg. @[email protected] status A6B42J
Abandons a game.
abandon <shortcode>
eg. @[email protected] abandon A6B42J
Advances a game (even if its current move has not expired).
advance <shortcode>
eg. @[email protected] advance A6B42J