Skip to content

Getting Started

To get started, grab a release of Lite XL. All the files are available on GitHub, and some package managers provide packages for Lite XL.

Base and Addons Packages

Since Lite XL v2.1.0, we provide two releases per platform — the base and addons packages. The base release contains a minimal release of Lite XL and essential plugins, while the addons package contains a full suite of plugins and syntax-highlighting support out-of-the-box.

Most users should choose the addons package as it provides most features out-of-the-box. However, if you plan to customize Lite XL from scratch, the base release is for you.

The addons package is going away.

We know that this dual-package convention is confusing, so we are working on lpm to enable users to customize their plugins on first launch.

Windows

On Windows, Lite XL is available as an installer or a zip archive. To use the installer, simply run it and follow the steps outlined by the installer.

To install Lite XL from a zip archive, extract it to a directory and run it directly.

Never run Lite XL directly from the zip archive.

Lite XL requires extra files that are present in the zip archive to function. Running it may cause crashes or unexpected errors.

Linux

Linux distributions usually install packages via their respective package managers. If a package is available for your distribution, you can install it from there.

Lite XL is available as an AppImage or tarballs. For AppImages, you can simply make it executable and run it.

If you encounter issues with the AppImage, verify whether fuse is installed.

AppImages require FUSE to function. Please visit AppImage Troubleshooting Guide for details.

To install Lite XL from a tarball, you should extract it to a temporary directory and move each files into place. For instance:

tar -xzf <file>
cd lite-xl

# to run Lite XL without installing, simply do the following:
# ./lite-xl

# remove previous installation files
rm -rf $HOME/.local/share/lite-xl $HOME/.local/bin/lite-xl
mkdir -p $HOME/.local/bin && cp lite-xl $HOME/.local/bin
mkdir -p $HOME/.local/share/lite-xl && cp -r data/* $HOME/.local/share/lite-xl

You may encounter older releases that has the files laid out in the correct directories (e.g. bin, share); in that case copying them to your installation directory ($HOME/.local or /usr) is sufficient.

Adding Lite XL to PATH

If you can't launch Lite XL from the terminal after installation, you need to put $HOME/.local/bin into PATH. Instructions may vary according to your shell, but for bash, simply run the following line:

echo -e 'export PATH=$PATH:$HOME/.local/bin' >> $HOME/.bashrc

Lite XL icon not showing on app launchers

On certain systems, you might want to run the following command to update the cache:

xdg-desktop-menu forceupdate

macOS

Installation on macOS is fairly straightforward — we provide DMG files that you can mount and drag-and-drop Lite XL into your Applications folder.

For older versions of Lite XL (before v2.1.2), you will need to clear App attributes from the application to launch it. To do so, you need to run the following command:

$ xattr -cr /Applications/Lite\ XL.app

For releases v2.1.2 and above, you just need to right-click on Lite XL in Finder and click "Open". If this is your first time launching Lite XL, macOS will display a prompt. Click "OK" and the Lite XL will launch.

Other Platforms

Lite XL does not produce binary releases for other platforms. To run the editor in other platforms, you may want to build Lite XL yourself.

Portable mode

Lite XL searches (directory to lite-xl.exe)/user for configuration, which allows users to create portable installations that doesn't use the user's configuration.

To create a portable installation, simply create a user directory where Lite XL executable is located.

Issues and workarounds

Lite XL may have issues on certain platforms that can be worked around by the user. A list of issues and workarounds are documented here.