Install

Repository install

Arch Linux (AUR)

yay -S fcitx5-vinput-bin

Fedora (COPR)

sudo dnf copr enable xifan/fcitx5-vinput-bin
sudo dnf install fcitx5-vinput

Ubuntu 24.04 (PPA)

sudo add-apt-repository ppa:xifan233/ppa
sudo apt update
sudo apt install fcitx5-vinput

Nix (flake)

Supports x86_64-linux and aarch64-linux. Binary cache is available via Cachix — pre-built binaries are used automatically when building the flake.

Home Manager example

Add fcitx5-vinput as a flake input:

{
  description = "Your flake description";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    home-manager.inputs.nixpkgs.follows = "nixpkgs";

    fcitx5-vinput = {
      url = "github:xifan2333/fcitx5-vinput";
    };
  };

  # Trust the fcitx5-vinput binary cache so nix uses pre-built binaries
  nixConfig = {
    extra-substituters = [ "https://fcitx5-vinput.cachix.org" ];
    extra-trusted-public-keys = [ "fcitx5-vinput.cachix.org-1:XpX3AA6+dDIX4qJhb1QM7sbTwX6/qSlGvW8Z5NK6XdU=" ];
  };

  outputs =
    {
      self,
      nixpkgs,
      nixos-hardware,
      home-manager,
      ...
    }@inputs:
    let
      system = "x86_64-linux";
      pkgs = import nixpkgs {
        inherit system;
      };
      homeManagerConfiguration = home-manager.lib.homeManagerConfiguration;
    in
    {
      homeConfigurations = {
        "kakapt@krypton" = homeManagerConfiguration {
          inherit pkgs;
          modules = [ ./your_home_module.nix ];
          extraSpecialArgs = inputs;
        };
      };
    };
}

Then put fcitx5-vinput into your Fcitx5 addon wrapper:

{ pkgs, ... }@inputs:
let
  fcitx5-vinput = inputs.fcitx5-vinput.packages."${pkgs.stdenv.hostPlatform.system}".default;
in
{
  home.packages = [
    fcitx5-vinput
  ];

  i18n.inputMethod = {
    enable = true;
    type = "fcitx5";
    fcitx5.addons = with pkgs; [
      fcitx5-vinput
    ];
  };
}

Flatpak

flatpak remote-add --if-not-exists xifan https://xifan2333.github.io/flatpak-auto/xifan.flatpakrepo
flatpak install https://xifan2333.github.io/flatpak-auto/refs/org.fcitx.Fcitx5.Addon.Vinput.flatpakref

After installation, grant additional permissions and restart Fcitx5:

flatpak override --user --filesystem=xdg-run/pipewire-0 org.fcitx.Fcitx5
flatpak override --user --filesystem=xdg-config/systemd:create org.fcitx.Fcitx5
flatpak kill org.fcitx.Fcitx5

Local install

Download the package for your distribution and install it directly.

Loading latest release…

After downloading:

• .deb: sudo dpkg -i <file>.deb && sudo apt-get install -f
• .rpm: sudo dnf install <file>.rpm
• .pkg.tar.zst: sudo pacman -U <file>.pkg.tar.zst
• .flatpak: flatpak install <file>.flatpak

Build from source

Dependencies: cmake, fcitx5, pipewire, libcurl, nlohmann-json, CLI11, Qt6

sudo bash scripts/build-sherpa-onnx.sh
cmake --preset release-clang-mold
cmake --build --preset release-clang-mold
sudo cmake --install build

Or use just:

just sherpa
just configure-release
just build
sudo just install

The first step downloads the pre-built sherpa-onnx runtime used by local builds and release packaging. Runtime libraries are bundled with the installed artifacts instead of being declared as a separate system package dependency.

Source builds default to the Fcitx5 system prefix (/usr) so the addon is installed under the directories Fcitx5 scans.