pls 6.0.0.post1

pls is a prettier and powerful ls(1) for the pros

⚠️ HEADS UP! pls has been rewritten in Rust.

The new GitHub repository is pls-rs/pls and the docs can be found at pls.cli.rs.

Version 6.0.0 and below are unmaintained. It is recommended that you upgrade to v7.0.0-beta.1 or newer using any of the distribution channels mentioned in this doc which includes PyPI by the way.

uv tool install pls --prerelease allow

Other options include Homebrew, Cargo, Binstall, Eget, or manually downloading a prebuilt binary from GitHub.

---

The following README.md is left as a reference. Most links will 404 and most images will be broken.

Links:

pls is a prettier and powerful ls for the pros.

The "p" stands for

• pretty (the output from pls surely looks better)
• powerful (pls has lots of features and endless customisation)
• programmer (pls is geared towards developers)
• professional (pls can be extensively tweaked by the pros)
• Python (pls is written in Python!)

Just pick whichever helps you remember the command name.

It works in a manner similar to ls, in that it lists directories and files in a given directory, but it adds many more developer-friendly features.

⚠️ Note that pls is not a replacement for ls. ls is a tried, tested and trusted command with lots of features. pls, on the other hand, is a simple tool for people who just want to see the contents of their directories.

Documentation

We have some very beautiful documentation over on our GitHub pages site. These docs are built from the docs branch in the same repository, and contributions to the docs are most welcome.

The docs contain information on almost everything, including but not limited to the following:

• installation and updates
• features and CLI options
• reference
• contribution