Getting Started

This guide covers the shortest path from a fresh install to a usable wkey setup.

Install

Install via AUR for archlinux user

yay -S wkey

Build from source:

cargo build --release

The binary will be available at:

target/release/wkey

Install into Cargo's binary directory from this repository:

cargo install --path .

A terminal with standard ANSI support
fzf is optional
If fzf is installed, wkey --search uses it first
If fzf is missing or cannot be launched, wkey falls back to an internal selector

Create the default config:

wkey init --yes

This creates:

$XDG_CONFIG_HOME/wkey/
  config.toml
  keyboard.txt
  groups/
    wkey.toml

The bundled wkey.toml group gives a fresh install something useful to browse immediately.

wkey init now creates a default config.toml too. Optional clipboard-style note pipeout:

# $XDG_CONFIG_HOME/wkey/config.toml
[pipeout]
command = "wl-copy"

Create a shortcut:

wkey shortcut create --group shell copy --key Ctrl+C --desc "Copy selection"

Create a note:

wkey note create --group shell prompt-tip --desc "Use !! to repeat the previous command"

The same flow using aliases:

wkey s c -g shell copy -k Ctrl+C -d "Copy selection"
wkey n c -g shell prompt-tip -d "Use !! to repeat the previous command"

Open the TUI:

wkey

Open the TUI after preselecting an item:

wkey --search

Alias form:

wkey -s

Run only the selector and print the selected item's description:

wkey --search-only

If pipeout.command is configured, wkey --search-only also sends that selected description to the pipeout command.