Usage
Installation
- Via a binary: Binaries for your platform can be obtained here. If the binary is a ".pkg.tar.zst" file, install this binary with Arch Linux's package manager. If the binary is a ".deb" file, install this binary with DPKG. If the binary is a binary, place this binary into a directory of your choice and add this directory to your system's path.
- Via an installl script: Installer scripts for Linux, Windows, and Mac OS can be found here. On Linux and Mac OS, download the script with cURL and run the script. On Windows, download the file and run the script with Powershell.
- Via Rust's package manager, Cargo: You can install the latest tagged release of the Jirai compiler with Cargo via the following command:
cargo install --git https://source.alyxshang.boo/alyxshang/jirai --features=cli --tag v.0.3.0.
Uninstalling the compiler
- If you placed a binary into a directory on your system path, delete the binary from the directory you put it in.
- If you installed a package, use the command your package manager offers to remove the "jiraic" package.
- If you installed the compiler via Cargo, use the
cargo uninstall jirai command to remove the compiler.
Using the compiler
- Compiling a Jirai file into HTML:
jiraic --build file.jirai. You can optionally specify an --out parameter to customize the name of the output file. - Linting a Jirai file:
jiraic --lint file.jirai. This will tell you whether the specified file contains valid Jirai code. - Getting help information:
jiraic --help - Getting version information:
jiraic --version