Set up Pkl in your editor

formae uses Pkl as its configuration language. Pkl has strong editor support (type checking, autocomplete, go-to-definition), which makes writing formae far easier. This guide gets it working in your editor.

Install Java

The Pkl language server runs on Java, so you need a JDK installed.

SDKMAN (recommended)
macOS (Homebrew)
Linux (direct)

SDKMAN lets you manage and switch between Java versions easily.

curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"
sdk install java

Verify:

java --version

brew install openjdk

Download and install OpenJDK from jdk.java.net, then make sure the java binary is on your PATH.

Add Pkl support to your editor

VS Code
Neovim

Install the official Pkl extension:

Open the Pkl VS Code installation guide.
Install the extension from the VS Code Marketplace.

Install Pkl support with your plugin manager.Using lazy.nvim:

{
  'apple/pkl-neovim',
  dependencies = {
    'nvim-treesitter/nvim-treesitter',
  },
  build = function()
    vim.cmd('TSInstall! pkl')
  end,
  ft = 'pkl',
}

Using vim-plug:

Plug 'apple/pkl-neovim'
Plug 'nvim-treesitter/nvim-treesitter'

After installing, run :TSInstall pkl to install the Pkl Tree-sitter parser.

New to Pkl?

If you’re new to the language, the Pkl primer covers the fundamentals in a few minutes: basic syntax and structure, types and validation, and modules and imports. See also the Pkl cheatsheet for a quick syntax reference.

Write your first forma AI assistants

⌘I

Get started

Guides

Concepts

Reference

Set up Pkl in your editor

New to Pkl?

​New to Pkl?

New to Pkl?