Skip to main content

​
Installation

List (sls) can be installed on macOS and Linux systems that support Swift. Choose the installation method that works best for you.

​
Prerequisites

Before installing List, ensure your system meets these requirements:
  • Swift: Version 6.2 or later
  • Platform: macOS 13.0 (Ventura) or later, or a compatible Linux distribution
  • Git: Required if building from source
List uses Swift 6.2 features and requires macOS 13.0 as the minimum deployment target.

​
Installation methods

1

Choose your installation method

You can either build List from source for the latest version, or download a pre-built binary for convenience.Building from source is recommended if you want the latest features or need to customize the build.
2

Install Swift (if needed)

Verify that Swift is installed on your system:
swift --version
You should see Swift version 6.2 or later. If Swift is not installed:macOS: Install Xcode from the Mac App Store, or install the Command Line Tools:
xcode-select --install
Linux: Download Swift from swift.org and follow the installation instructions for your distribution.
3

Build from source

Clone the List repository and build the executable:
git clone https://github.com/mac9sb/list.git
cd list
swift build -c release
The build process compiles List with optimizations enabled. The executable will be created at .build/release/sls.
The -c release flag builds an optimized production binary. This provides better performance than a debug build.
4

Install the binary

Copy the compiled executable to a directory in your PATH:
cp .build/release/sls /usr/local/bin/
This makes the sls command available system-wide. You may need to use sudo depending on your permissions:
sudo cp .build/release/sls /usr/local/bin/
Ensure /usr/local/bin is in your PATH. You can verify this by running echo $PATH.
5

Verify installation

Confirm that List is installed correctly:
sls --version
You should see the version number (1.5.0 or later) displayed.

​
Alternative: Download pre-built binary

If you prefer not to build from source, you can download a pre-built binary:
  1. Visit the releases page
  2. Download the latest binary for your platform
  3. Extract the archive and copy sls to /usr/local/bin/
  4. Make the binary executable:
chmod +x /usr/local/bin/sls

​
Custom installation location

If you want to install List to a custom location instead of /usr/local/bin/, you can: 
# Copy to a custom location
cp .build/release/sls ~/bin/sls

# Add to your PATH in ~/.bashrc or ~/.zshrc
export PATH="$HOME/bin:$PATH"
After modifying your shell configuration, reload it: 
source ~/.bashrc  # or ~/.zshrc

​
Uninstalling

To remove List from your system, simply delete the executable: 
sudo rm /usr/local/bin/sls

​
Next steps

Now that you have List installed, learn how to use it:

Quickstart guide

Get started with your first List commands and explore common usage patterns

Build docs developers (and LLMs) love

Get started for freeTalk to us