/crontab-text-explainer

An open-source React/TypeScript application built with Vite to help developers and system administrators understand and create cron expressions through interactive visualizations and random cron expression generation.

Primary LanguageTypeScript

Crontab Text Explainer

Overview

Crontab-Text-Explainer is a lightweight tool that translates crontab strings into human-readable descriptions. If you've ever wondered what a crontab expression like * * * * * actually means, this tool is for you. It dissects the crontab format and gives a plain language explanation of when your cron job is scheduled to run.

Table of Contents

Features

  • Full Crontab Support: Handles all standard fields in a crontab expression (minute, hour, day of the month, month, day of the week).
  • No External Libraries: Built purely with Js/Ts, using no third-party libraries.
  • Interactive Interface: Web page for input and output.
  • Error Validation: Ensures the input crontab string is correctly formatted before processing.

Installation

  1. Clone the repository: 
    https://github.com/nofil-zahid/crontab-text-explainer.git
  2. Navigate to the project directory: 
    cd crontab-text-explainer
  3. Install Packages: 
    npm install
  4. Run: 
    npm run dev

Examples

  • Input: * * * * *

    • Output: "At every minute"

  • Input: 0 12 * * 1-5

    • Output: "At 12:00 on every day-of-week from Monday through Friday"

  • Input: 3 2 * 1,4,5 1-5

    • Output: "At 02:03 on every day-of-week from Monday through Friday in January, April and May"