Skip to main content

`pls` is a better `ls` for developers.

Project description

pls on PyPI Python ^3.9 GPL-3.0-or-later

pls is a better ls for developers. The "p" stands for "pro" as in "professional" or "programmer".

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 tool 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.

Features

pls provides many features over ls command. pls can:

  • show Nerd Font icons or emoji next to files and directories making it easier to grep the output
  • colour output to further distinguish important files
  • use a more nuanced approach to hidden files than plainly hiding files with a leading dot .
  • groups directories and shows them all before files
  • ignores leading dots . in sorting files

The icon, color and most behaviour in the application can be configured using plain-text YAML files for the pros who prefer to tweak their tools.

Upcoming features

In the future pls will be able to

  • generate visibility rules by parsing .gitingore
  • add MIME type as another method for matching files to specs
  • use complete path based matching for files
  • cascade specs based on specificity levels
  • provide channels to extend specs per user, per project
  • link files and hide derived files behind the main ones
  • support more columns like permissions, owner and size
  • support for tree-like output

If you want to help implement any of these features, feel free to submit a PR. pls is free and open-source software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pls-1.0.0.tar.gz (24.0 kB view hashes)

Uploaded Source

Built Distribution

pls-1.0.0-py3-none-any.whl (27.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page