Skip to content

Latest commit

 

History

History
46 lines (43 loc) · 2.86 KB

File metadata and controls

46 lines (43 loc) · 2.86 KB

CLI Reference

A secure, modern and customizable Wayland session locker

Usage: nilock [OPTIONS]

Options:
      --config <PATH>                  Read config from PATH
      --no-config                      Do not read any config file
      --dump-default-config            Print a default config file and exit
      --self-check                     Run environment checks without locking
      --benchmark-blur                 Benchmark CPU blur and exit
      --size <WxH>                     Benchmark blur at a single resolution, for example 2560x1440
      --radius <RxR>                   Benchmark blur radius, default 7x5
      --preset <PRESET>                Apply a built-in theme preset [possible values: catppuccin-mocha, gruvbox-dark, nord]
      --color <COLOR>                  Background color as 6-digit RGB hex
      --debug                          Enable detailed logs and evdev ASCII fallback
      --ignore-empty                   Do not authenticate an empty password
      --no-ignore-empty                Authenticate an empty password
      --debug-escape                   Ctrl+Alt+Backspace unlocks without PAM
      --debug-timeout <SECONDS>        Unlock automatically after SECONDS
      --log-file <PATH>                Write logs to PATH
      --clock                          Show clock
      --no-clock                       Hide clock
      --time-format <FMT>              Clock time format
      --date-format <FMT>              Clock date format
      --indicator                      Show password/status indicator
      --no-indicator                   Hide password/status indicator
      --inside-color <HEX>             Indicator inside color
      --ring-color <HEX>               Indicator ring color
      --text-color <HEX>               Text color
      --wrong-color <HEX>              Wrong password color
      --verifying-color <HEX>          Verifying color
      --wallpaper <PATH>               Use image file as background when screenshots are off
      --screenshots                    Use per-output screenshots as background
      --no-screenshots                 Use solid color background
      --effect-blur <RxR>              Apply box blur to screenshots, for example 7x5
      --effect-vignette <BASE:FACTOR>  Apply vignette to screenshots, for example 0.5:0.5
      --effect-fade <MS>               Fade from sharp background to processed background over MS milliseconds
      --indicator-style <STYLE>        Password indicator visual style [default: classic] [possible values: classic, pill, radial]
      --clock-layout <LAYOUT>          Clock and date layout style [default: classic] [possible values: classic, large, compact]
      --indicator-ring                 Show indicator outer ring border
      --no-indicator-ring              Hide indicator outer ring border (borderless style)
  -h, --help                           Print help