🖦 Implement the /help command

[programarivm]

Figure 1. Visit the website and click on the Console link at the bottom of the page.

The /help command is intended to be used from the console command line, and it will return a list of all available commands along with a brief description of each.

This is similar to the help obtained when starting the services.

php cli/workerman/data.php start
Welcome to PHP Chess Server
Commands available:
/annotations_game Annotated chess games.
/ranking Top players by ELO.
/autocomplete_black {"params":"<string>"} Autocomplete data for chess players.
/autocomplete_event {"params":"<string>"} Autocomplete data for chess events.
/autocomplete_white {"params":"<string>"} Autocomplete data for chess players.
/opening {"params":"<string>"} Opening results.
/search {"params":"<string>"} Finds up to 25 games matching the criteria.

Listening to commands...

php cli/workerman/game.php start
Welcome to PHP Chess Server
Commands available:
/eval_names Returns the evaluation names.
/online_games Returns the online games in pending status to be accepted.
/undo Undoes the last move.
/draw {"action":["accept","decline","propose"]} Offers a draw.
/rematch {"action":["accept","decline","propose"]} Offers a rematch.
/takeback {"action":["accept","decline","propose"]} Takes back a move.
/accept {"params":"<string>"} Accepts an invitation to play online with an opponent.
/heuristic {"params":"<string>"} Balance of a chess heuristic.
/leave {"params":"<string>"} Leaves a game.
/legal {"params":"<string>"} Returns the legal FEN positions of a piece.
/play_lan {"params":"<string>"} Plays a move in long algebraic notation.
/play_rav {"params":"<string>"} Plays the moves in a RAV movetext.
/randomizer {"params":"<string>"} Starts a random position.
/recognizer {"params":"<string>"} Returns the piece placement in FEN format of a Base64 encoded image.
/resign {"params":"<string>"} Resigns a game.
/restart {"params":"<string>"} Restarts an existing game.
/start {"params":"<string>"} Starts a new game.
/stockfish {"params":"<string>"} Returns Stockfish's response to the current position.
/tutor_fen {"params":"<string>"} Explains a FEN position in terms of chess concepts.

Listening to commands...

php cli/workerman/binary.php start
Welcome to PHP Chess Server
Commands available:
/image {"params":"<string>"} Transmits an image.

Listening to commands...

php cli/workerman/auth.php start
Welcome to PHP Chess Server
Commands available:
/totp_refresh {"params":"<string>"} Refresh the TOTP access token.
/totp_signin {"params":"<string>"} TOTP sign in.
/totp_signup TOTP sign up URL.

Listening to commands...