bbot-cli v0.9.0

bbot-cli

CLI simulator of Bee-Bot toy robot moving on a square tabletop, of dimensions 5 units x 5 units. Commands can be provided either via scenario file or interactively.

The origin (0,0) can be considered to be the SOUTH WEST most corner.

Bee-Bot support following commands:

• PLACE X,Y,F will put the toy robot on the table in position X,Y and facing NORTH, SOUTH, EAST or WEST.
• MOVE will move the toy robot one unit forward in the direction it is currently facing.
• LEFT will rotate the robot 90 degrees counterclockwise without changing the position of the robot.
• RIGHT will rotate the robot 90 degrees clockwise without changing the position of the robot.
• REPORT will announce the X,Y and F of the robot.

The first valid command to the robot is a PLACE command, after that, any sequence of commands may be issued, in any order, including another PLACE command. The application will discard all commands in the sequence until a valid PLACE command has been executed.

if scenario file is not provided application will run in interactive mode. To exit interactive mode type exit or q.

• Usage
• Commands

Usage

$ npm install -g bbot-cli
$ bbot-cli COMMAND
running command...
$ bbot-cli (-v|--version|version)
bbot-cli/0.9.0 darwin-x64 node-v12.18.3
$ bbot-cli --help [COMMAND]
USAGE
  $ bbot-cli COMMAND
...

$ npm install -g bbot-cli
$ bbot-cli run -s=scenario.example
Welcome to the Bee-Bot simulator!
Reading scenarion from the file:/Users/bot/bbot-cli/scenario.example
Scenario has 2 commands
PLACE x:3 y:3 face:EAST - executed
Bot state: x:3 y:3 face:EAST
Bee-Bot run complete.
$ bbot-cli (-v|--version|version)
bbot-cli/0.1.0 darwin-x64 node-v12.18.3
$ bbot-cli --help run
USAGE
  $ bbot-cli run
...

Commands

• bbot-cli run [-s=[FILE]]
• bbot-cli help [COMMAND]

bbot-cli run [-s=[FILE]]

run command can be executed in 2 modes. If the scenario file provided CLI run in automatic mode: read scenario file, execute it and exit. If file is not provides CLI will start in interactive mode and will prompt for individual commands to be immidiatly executed. Whole interactive session treated as a single scenario. Command exit or q will finish interactive session.

USAGE
  $ bbot-cli bbot-cli run -s=<scenario.file>

OPTIONS
  -h, --help                      show CLI help

  -s, --scenariofile=scenariofile path to scenarion file. file must contain
                                  valid Bee-Bot commands. Each command must
                                  start from a new line.

DESCRIPTION
  The application is a simulation of a Bee-Bot toy robot moving on a square tabletop,
  of dimensions 5 units x 5 units. Commands can be provided either via scenario file
  or interactively.
  The origin (0,0) can be considered to be the SOUTH WEST most corner.

  Bee-Bot support following commands:
    * PLACE X,Y,F  will put the toy robot on the table in position X,Y and facing
                   NORTH, SOUTH, EAST or WEST.
    * MOVE         will move the toy robot one unit forward in the direction it is
                   currently facing.
    * LEFT         will rotate the robot 90 degrees counterclockwise without changing
                   the position of the robot.
    * RIGHT        will rotate the robot 90 degrees clockwise without changing the
                   position of the robot.
    * REPORT       will announce the X,Y and F of the robot.

  The first valid command to the robot is a PLACE command, after that, any sequence
  of commands may be issued, in any order, including another PLACE command. The
  application will discard all commands in the sequence until a valid PLACE command
  has been executed.

  if scenario file is not provided application will run in interactive mode. To exit
  interactive mode type 'exit' or 'q'.

EXAMPLE
  $ bbot-cli run -s=scenario.example
  Welcome to the Bee-Bot simulator!
  Reading scenarion from the file:/Users/bot/bbot-cli/scenario.example
  Scenario has 2 commands
  PLACE x:3 y:3 face:EAST - executed
  Bot state: x:3 y:3 face:EAST
  Bee-Bot run complete.

See code: src/commands/run.ts

bbot-cli help [COMMAND]

display help for bbot-cli

USAGE
  $ bbot-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Development & Testing

Code of the CLI structured in 2 folders:

• src - contains all CLI code
• test - contains all tests

To run code in dev mode:

$ cd bbot-cli
$ ./bin/run run
Welcome to the Bee-Bot simulator!
Enter command for Bee-Bot to execute [PLACE, MOVE, LEFT, RIGHT, REPORT]
? command █

To run tests:

$ cd bbot-cli
$ yarn test