Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

A whoosh-based CLI indexer and searcher for your files.

Project Description

Create fulltext indexes with your files and query them from the command line.


With pip or (better) pipsi <>:

pipsi install --python (which python3) washer
# or `sudo pip3 install washer`


Usage: washer [OPTIONS] COMMAND [ARGS]...

  -d, --indexdir DIRECTORY  The directory in which the index files will be
                            kept. Defaults to a temporary directory.
  --help                    Show this message and exit.

  index     Creates or overwrites and index at an...
  info      Display information about the index and...
  morelike  Lists files present at the index that share...
  search    Search the given index for a term or multiple...
Usage: washer index [OPTIONS] [FILES_TO_INDEX]...

  Creates or overwrites and index at an specified location using the given

  FILES_TO_INDEX accepts multiple files and wildcards, as usual.

  -l, --lang [ar|da|nl|en|fi|fr|de|hu|it|no|pt|ro|ru|es|sv|tr]
                                  Comma-separated list of languages to use
                                  when indexing. Should be specified multiple
                                  times. Defaults to "-l pt -l en".
  --help                          Show this message and exit.
Usage: washer search [OPTIONS] [QUERY]...

  Search the given index for a term or multiple terms.

  QUERY can be anything, typically it will be just one or a bunch of words,
  but it accepts special operators (NOT, AND, *, ? etc.) as specified in

  --count             Force counting results. A mostly useless flag.
  --frag / --no-frag  Show text fragments of the files that matched.Enabled by
  --help              Show this message and exit.


This tool is licensed in the same way as Whoosh, as long as it complies with requirements from the other two dependencies, click and blessings.

Release History

This version
History Node


History Node


History Node


History Node


History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(4.9 kB) Copy SHA256 Hash SHA256
Source None Aug 20, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers