Skip to main content

​
Quickstart

This guide will help you get started with List (sls) and explore its most useful features. You’ll be listing files like a pro in minutes.

​
Your first command

Once List is installed, using it is simple. Just run sls in any directory: 
sls
This lists all files in your current directory, similar to running ls. You’ll see a clean output with file names.

​
Basic usage patterns

Here are the most common ways to use List in your daily workflow:
1

List files in a specific directory

You can specify a path to list files in any directory:
sls /path/to/directory
Example:
sls ~/Documents
sls /etc
sls .
2

Show hidden files

Use the --all or -a flag to include hidden files (those starting with .):
sls --all
sls -a
This reveals configuration files and other hidden items in your directory.
3

Use long format for detailed information

The --long or -l flag displays detailed file attributes:
sls --long
sls -l
Long format shows:
  • File permissions
  • Owner and group
  • Number of links
  • File size
  • Modification date and time
  • File name
4

Sort files by time or size

List can sort your files in different ways:Sort by modification time (most recent first):
sls --sort-time
sls -t
Sort by file size (largest first):
sls --sort-size
sls -S
Default sorting is alphabetical by name.

​
Common usage examples

Here are practical examples combining multiple options: 
sls --all --long
sls -al

​
Advanced features

Once you’re comfortable with basic usage, try these powerful features:

​
Recursive listing

Explore directory structures recursively: 
sls --recurse
sls -r
Limit recursion depth to avoid deep trees: 
sls --recurse --depth-limit 2
sls -r -L 2

​
File type indicators

Append indicators to show file types at a glance: 
sls --classify
sls -F
This adds symbols like:
  • / for directories
  • * for executables
  • @ for symbolic links

​
One file per line

Display each file on its own line for easier parsing: 
sls --one-line
sls -1

​
List directories only

Show directory entries themselves, not their contents: 
sls --directory /path/to/dir
sls -d ~/Documents

​
Multiple paths

You can list multiple directories in one command: 
sls ~/Documents ~/Downloads ~/Desktop
Each directory is labeled with its path for clarity.

​
Getting help

View all available options and flags: 
sls --help
sls -h
Check the installed version: 
sls --version

​
Practical workflow examples

Here are some real-world scenarios where List shines: 
sls --sort-time --long
This shows files sorted by modification time with full details, perfect for finding what you worked on recently.
sls --recurse --depth-limit 2 --color --icons
Get a colorful overview of your project structure without going too deep into subdirectories.
sls --sort-size --human-readable --long
Identify the largest files in a directory to free up disk space.
sls --all --long ~/
View all configuration files in your home directory with detailed permissions.
Flags can be combined in short form. For example, sls -alS is equivalent to sls --all --long --sort-size.

​
Next steps

You now know the essential List commands. To dive deeper:
  • Explore the Command Reference for a complete list of flags and options
  • Learn about Configuration to customize List’s behavior
  • Check out Advanced Usage for power user techniques

Command Reference

View detailed documentation for all available commands and options

Build docs developers (and LLMs) love

Get started for freeTalk to us