Skip to main content

⚠️ 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.

Python versions GPL-3.0 Platforms CI status LoC

Links:

pls on PyPI Docs

Demo of `pls` Help of `pls`

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:

Release files for pls 6.0.0.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pls 6.0.0.post1
File Size Uploaded
pls-6.0.0.post1.tar.gz 53.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pls 6.0.0.post1
File Interpreter ABI Platform
pls-6.0.0.post1-py3-none-any.whl Python 3 none any Details

Total release size: 127.4 kB

Release files / pls-6.0.0.post1.tar.gz

Download URL pls-6.0.0.post1.tar.gz
Size 53.1 kB
Tags Source
SHA-256 checksum
How to use checksums
8d67418e0cc4a51985911b71592c97c922057a1f06fe07bca1a35d4c363e47a6
BLAKE2b-256 checksum
How to use checksums
3960d3573d31c775336055ff26836d0be29dde33e70d5fe257a85471d347481d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release files / pls-6.0.0.post1-py3-none-any.whl

Download URL pls-6.0.0.post1-py3-none-any.whl
Size 74.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8034ccc233b49a7c59c12309f1c52c7f5ef4ff3e6b0c1177bf5ac462df7961e
BLAKE2b-256 checksum
How to use checksums
e497dd7da2296f5ab7e901f98d3a81c1cd105dffa2ea3af1185d91345349bffc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release history Release notifications | RSS feed

This release

6.0.0.post1 This release

2 release files

6.0.0

2 release files

5.4.0

2 release files

5.3.0

2 release files

5.2.0

2 release files

5.1.2

2 release files

5.0.0

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.13.1

2 release files

1.13.0

2 release files

1.12.0

2 release files

1.11.1

2 release files

1.11.0

2 release files

1.9.3

2 release files

1.9.2

2 release files

1.9.1

2 release files

1.9.0

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page