Skip to content

README.md

Latest commit

 

History

History
38 lines (24 loc) · 1.62 KB

README.md

File metadata and controls

38 lines (24 loc) · 1.62 KB

Commandtrein

Commandtrein is a command-line interface (CLI) tool designed to access and display timetables and route information for SNCB (Belgian Railways) directly from your terminal.

• Documentation • Features highlights • Quickstart

commandtrein

Build

Features

  • Timetables: retrieve and display the current timetable for any SNCB station.
  • Routes: Get detailed connections and travel times between two SNCB stations.
  • Shortcuts: Configure and use shortcuts for frequently used routes.

Documentation

Installation

Usage

Shell completion

Configuration

Commandtrein uses a YAML configuration file located at ~/.config/commandtrein/config.yaml. This files stores your shortcuts for frequent routes.

Example configuration:

shortcuts:
  work:
    station1: "Brussel-Midi"
    station2: "Antwerpen-Centraal"

Acknowledgements

Commandtrein leverages the iRails API, an open-source API for accessing real-time data from SNCB.