Skip to content

A CLI that shows live railway station departure boards in the terminal

License

Notifications You must be signed in to change notification settings

jackdevey/Boards

Repository files navigation

📺 Boards

Boards is a CLI written in node.js that shows accurate & live railway station departure boards in the terminal, using data sourced from the National Rail Enquiries API.

Using Boards

Generating a live departure board is easy, and can be done in the terminal using just one command!

Boards clears the terminal before running to provide a cleaner viewing experience

boards [CRS] [NUM]

Please note the following parameters:

Name Description Required Default
CRS The Computer Reservation System code for the station, you can find a list of all of these here Yes -
NUM The number of services to display on the board No 10

Boards keeps running to provide a live feed of all services, but can be stopped by using Ctrl + C to terminate the program.

Example

Running Boards to generate a live departure board for Birmingham New Street Station

boards BHM

Returns the following departure board, last updated (21/04/2022)

image

License

http://www.gnu.org/licenses/gpl-3.0.en.html

Boards is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Boards gets all of its realtime data from National Rail's Live Departure Boards Web Service