wf-recorder

Record storing to an MP4 file

$ wf-recorder [[-f|--file]] [output.mp4]

$ wf-recorder [[-a|--audio]] [[-f|--file]] [/path/to/file_with_audio.webm]

$ wf-recorder [[-g|--geometry]] "$(slurp)"

wf-recorder [options] [output_file]

-h, --help
    Show help message and exit.

-v, --version
    Show version information and exit.

-c , --codec
    Specify the video codec to use (e.g., h264, vp8, vp9). Defaults to auto-detection.

-f , --file
    Specify the output file format (e.g., mp4, webm, mkv). Defaults to auto-detection.

-x , --x
    X coordinate of the top-left corner of the region to record.

-y , --y
    Y coordinate of the top-left corner of the region to record.

-w , --width
    Width of the region to record.

-h , --height
    Height of the region to record.

-g , --geometry
    Specify the geometry of the region to record as WxH+X+Y (e.g., 1280x720+0+0).

-s , --fps
    Frames per second to record

-l , --length
    Recording length in seconds.

-d , --display
    The Wayland display to record, defaults to $WAYLAND_DISPLAY.

-a, --audio
    Record audio (requires appropriate audio sink configured).

[output_file]
    Path to the output file. If not specified, defaults to wf-recorder-$(date +%Y%m%d%H%M%S).mp4

wf-recorder is a command-line utility designed for recording the screen in Wayland compositors. Unlike traditional screen recording tools that rely on X11, wf-recorder directly interfaces with the Wayland protocol, offering a more efficient and reliable recording experience in Wayland environments. It captures the output of a specified window or the entire screen as video. It is designed to be simple, efficient, and configurable. You can customize options such as codec, frame rate, and output format.

The core philosophy is minimalism; providing only essential screen recording functionality without unnecessary bloat. It is particularly useful for Wayland users seeking a lightweight and reliable tool for creating screencasts, capturing gameplay, or recording presentations. It supports various video codecs like H.264, VP8, VP9, and AV1, as long as the required encoders are available on the system.

Requires a Wayland compositor. The availability of codecs and formats depends on the installed system libraries. Audio recording needs proper audio sink configuration.

Record the entire screen:
wf-recorder

Record a specific region:
wf-recorder -g 800x600+100+100 output.mp4

Record with a specific codec and framerate:
wf-recorder -c vp9 -s 30 output.webm

Record with audio:
wf-recorder -a output.mp4

wf-recorder was specifically designed to address the limitations of screen recording on Wayland. Traditional X11-based screen recorders don't work natively on Wayland. wf-recorder was developed to provide a minimal and efficient solution tailored for Wayland compositors. It has seen active development to improve codec support, stability, and performance.

ffmpeg(1), slurp(1)