Install

Roc is a very young language with many incomplete features and known bugs. It doesn't even have a numbered release yet, but it does have nightly builds that you can download, if you'd like to try it out without building from source! There are also official Docker images if you prefer to run Roc within a container.

There are currently a few known OS-specific issues:

• macOS: There are no known compatibility issues, but the compiler doesn't run as fast as it does on Linux or Windows, because we don't (yet) do our own linking like we do on those targets. (Linking works similarly on Linux and Windows, but the way macOS does it is both different and significantly more complicated.)
• Windows: There are some known Windows-specific compiler bugs, and probably some other unknown ones because more people have tried out Roc on Mac and Linux than on Windows.
• Linux: The nightlies are built with glibc, so they aren't usable on distros that don't use glibc, like Alpine. In the future we plan to build Linux releases with musl libc to address this, but this requires building LLVM from source with musl.
• Other operating systems: Roc has not been built on any other operating systems. Building from source on another OS might work, but you might very well be the first person ever to try it!

Getting Started

Here are some Getting Started guides for different operating systems:

• Linux x86-64
• Nix Linux/MacOS
• MacOS Apple Silicon
• MacOS x86-64
• Windows
• Other Systems

Editor Extensions/Plugins

• Visual Studio Code
  • Features: syntax highlighting, completion, type hints, jump to source
  • syntax highlighting, completion, type hints, jump to source
  • install the Roc Plugin
    • ❗make sure to follow "Configuring language server".
    • It would be a fantastic contribution for the language server to be set up automatically. If you'd like to help with this, just make a post in the "new contributors" topic on Zulip and say hello!
• Zed, since Version 0.133.5
  • Features: syntax highlighting, completion, type hints, jump to source
  • search and install roc extension (action zed: extensions)
  • in case of errors look into the Zed log (action zed: open log)
• For other editors like Vim, Helix or Emacs see

Tutorial

Once you've installed roc, check out the tutorial to learn how to Roc!

Start Tutorial