/vilark

Vilark: A fast, elegant file selector for the terminal

Primary LanguageC#Apache License 2.0Apache-2.0

Vilark

The file selector for humans. 😀

  • Works great with Vim, but can also be used from the CLI to launch any $EDITOR.

  • Uses C# AOT (100% native code compilation), so startup is lightning fast.

Tutorial Screen Recording

Installation Instructions - Docker

To build with Docker (for Linux or WSL2):

cd /tmp
git clone --depth 1 https://github.com/kjpgit/vilark
cd vilark
./build.sh --docker

Installation Instructions - Without Docker

To build without Docker (Linux, Mac, WSL2):

cd /tmp
git clone --depth 1 https://github.com/kjpgit/vilark
cd vilark
./build.sh

The build.sh script will automatically download the .Net 8 SDK to compile Vilark to a single-file executable with native code (GC, but no JIT).

After building, you can completely remove the .Net SDK to free up space.

If you have any build errors, please see the Microsoft .NET 8 Native Requirements , which are basically:

sudo apt-get install clang zlib1g-dev

Supported Terminals

iTerm2 Screenshot

A modern terminal emulator (24 bit color, xterm key sequences) is required. Vilark is tested on:

NOTE: The Google Roboto Mono font is missing certain box drawing characters and/or they have incorrect widths. Recommended fonts are "Consolas" or "Cascadia Code".

NOTE: Apple's Terminal.App and rxvt do not support 24 bit color codes, their so usage is not recommended.

Vim Requirements (For Vim Plugin)

Vim needs to be compiled with +python3 scripting support. This is the default for Ubuntu, as well as Brew on mac. (Don't use the default /usr/bin/vim on Mac)

Additional Documentation

Vilark User Guide

About Vilark

Lark (noun) : A source of or quest for amusement or adventure

Skylark (noun) : The male skylark sings as it flies

This project is the culmination of 25 years of experience. I hope it brings you as much joy as it does me.

© 2023 Karl Pickett / Vilark Project