Skip to content

Install Plume on your machine

Sisypheus edited this page Jun 12, 2024 · 6 revisions

Plume installation is a straightforward process. You can install Plume on your machine by following the instructions below.

First and foremost, you need to know your operating system. Plume is available on Linux, macOS, and Windows (note that other distributions will be supported in the future).

So, let's get started with the installation process.

Manual Installation

  1. Download the latest release of Plume from the official GitHub repository.
  2. Once you have downloaded the release, extract the archive and move the folder to a location of your choice.
  3. You can either add the Plume binary folder to your PATH environment variable or use the binary directly from the folder.
  4. Set the PLUME_PATH environment variable to the standard library folder. This is necessary for the compiler to find the standard library.
export PATH=$PATH:/path/to/plume/bin
export PLUME_PATH=/path/to/plume/standard

Installation through Scoop (Windows)

  1. Add the Plume bucket to Scoop:
scoop bucket add plume-lang https://github.com/plume-lang/plume-bucket
  1. Install Plume:
scoop install plume-lang/plume

Basic Usage of Plume

Plume, in its early stage, provides a basic CLI experience. You can compile and run Plume programs. Here is a simple example of how to compile and run a Plume program:

Given the following code:

// my_program.plm
println("Hello world from Plume") 

Run the following commands:

plumec my_program.plm # Outputs to my_program.js
node my_program.js # Outputs "Hello world from Plume"

That's it! You have successfully installed Plume on your machine and run your first program. Now you may be interested in learning more about the language's basic features.