Skip to content

How to install Rzk

These instructions will walk you through setting up Rzk using the "basic" setup and VS Code as the editor.

  1. Install VS Code.
  2. Launch VS Code and install the rzk extension.
  3. Create a new file using "File > New Text File" (Ctrl+N). Click the Select a language prompt, type in rzk, and select "Literate Rzk Markdown". VS Code rzk language selector.
  4. You should see the following popup: VS Code rzk install prompt.
  5. Click "Yes" button.
  6. While it is installing, you can paste the following literate Rzk program into the new file:
# Sample literate Rzk markdown

```rzk
#lang rzk-1
#define id (A : U)
  : A -> A
  := \ x -> x
```
  1. When the installation is done you should see the following popup: VS Code rzk reload prompt.
  2. Click "Reload button".
  3. Save your file as example.rzk.md.

  4. Open local Terminal (Ctrl+`).

  5. In the terminal, run

    rzk typecheck example.rzk.md

  6. You should see the output of the proof assistant:

    Loading file example.rzk.md
Checking module from example.rzk.md
[ 1 out of 1 ] Checking #define id
Everything is ok!

  7. Congratulations! Now you have a working rzk setup :) Note that the rzk extension will notify you about updates of rzk and prompt updating to new versions.

  8. See Quickstart to get familiar with the Rzk language!

Install binaries

Download from GitHub

You can download and use binaries (at least for some platforms) directly for one of the latest releases on GitHub at https://github.com/rzk-lang/rzk/releases. If your platform is not represented, please consider leaving an issue at https://github.com/rzk-lang/rzk/issues/new.

Install from sources

You can install rzk from sources. You can get the latest "stable" release from Hackage or build from the develop branch on GitHub.

Stack

To build and install with Stack from Hackage:

stack install rzk

To build and install with Stack from sources on GitHub:

git clone https://github.com/rzk-lang/rzk.git
cd rzk
git checkout develop
stack build && stack install

cabal-install

To build and install with cabal-install from Hackage:

cabal v2-update
cabal v2-install rzk

To build and install with cabal-install from sources on GitHub:

git clone https://github.com/rzk-lang/rzk.git
cd rzk
git checkout develop
cabal v2-build && cabal v2-install

Nix

Work-in-progress

To be done.