Skip to content

Getting Started

Installation

Prerequisites

  • Node.js version 18 or higher.
  • A terminal for accessing WhirlScript through its Command Line Interface (CLI).
sh
$ npm add -g whirlscript
sh
$ pnpm add -g whirlscript
sh
$ yarn global add whirlscript

Setup Guide

WhirlScript uses its package manager Whirlpkg.

shell
$ wrp init

Configuration Files

  • The whirlpkg.json file is used to store the package configuration;
  • The wrsconfig.json file is used to store the build configuration.

Compilation

Once you have completed your configuration, you can compile your source code like this:

shell
$ wrsc

Released under the MIT License.