Skip to main content

Installation

Build from source​

  1. Ensure the Rust toolchain is installed using rustup.rs.
  2. Use Rust 1.80.0:
rustup default 1.80.0
  1. Install openssl's development package
# Ubuntu
sudo apt install libssl-dev

# Fedora
sudo dnf install openssl-devel
  1. Clone the project:
git clone https://github.com/ki-editor/ki-editor.git
  1. Run installation:
cd ki-editor
cargo install --locked --path .
  1. The ki binary should be installed.

Use nix flake 1​

  1. Install ki package
  • with nix profile:
nix profile install github:ki-editor/ki-editor
  • or as part of nix configuration, e.g.:
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    ki-editor.url = "github:ki-editor/ki-editor";
  };

  outputs = { nixpkgs, ki-editor, ... }: {
    nixosConfigurations."«hostname»" = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
         { environment.systemPackages = [ ki-editor.packages.x86_64-linux.default ] }
         ./configuration.nix
      ];
    };
  };
}
  1. Build tree-sitter grammars:
ki @ grammar fetch && ki @ grammar build

Footnotes​

  1. This flake also provides a basic development environment for Ki Editor which can be enabled by nix develop command. ↩