Installation

Installation Instructions

Compiler & toolkit

From aikup (Linux & MacOS only)

First, install aikup: a basic utility tool to download and manage Aiken's pre-compiled executables:

curl -sSfL https://install.aiken-lang.org | bash

Then, simply run:

aikup

aikup alone installs the latest version available. You can install specific versions by specifying a version number. For usage instructions, use aikup --help.

From sources (All platforms)

cargo install aiken --version 0.19.0-alpha

cargo is a package manager for Rust. To install it, please refer to the Rust book (opens in a new tab).

From Nix flakes (Linux & MacOS only)

nix build github:aiken-lang/aiken#aiken

Language Server

The aiken command-line comes with a built-in language server (opens in a new tab). If needed, configure your language client with the following configuration (refer to your language client's instructions):

  • command: aiken lsp (the command is hidden from the command-line help usage)
  • root pattern: aiken.toml
  • filetype: aiken (.ak)

The language server supports a variety of capabilities (but not all). For more details, please refer to the supported capabilities (opens in a new tab) on the main repository.

Auto-completion

The command-line comes with few auto-completion scripts for bash, zsh and fish users. The scripts can be obtained using the aiken completion <shell> command. You can install completions on their standard/default locations as follows:

aiken completion bash > /usr/local/share/bash-completion/completions/aiken
source /usr/local/share/bash-completion/completions/aiken

Editor integrations

The following plugins provide syntax highlighting and indentation rules for Aiken.

EditorPlugin
VSCodeaiken-lang/editor-integration-vscode (opens in a new tab)
Vim/Neovimaiken-lang/editor-integration-nvim (opens in a new tab)
Emacsaiken-lang/editor-integration-emacs (opens in a new tab)