Skip to main content

ff

About

ff is a tool for searching the filesystem. It was originally inspired by fd.

NOTE: ff is in the early stages of development, expect things to break and syntax to change.

Summary

ff is a tool for searching the filesystem. Its scope is similar to find(1) and fd(1) but it tries to be more accessible and easier to use than find and and more versatile and powerful than fd. It is inspired by and borrows many ways of doing things from fd. It is written in Python >= 3.6.

Features

  • Search by file attributes and file metadata(!).
  • Simple yet powerful expression syntax.
  • Flexible output options.
  • Flexible sort options.
  • Extendable by user plugins.
  • Parallel search and processing.

Examples

Store all files from the current directory that are tracked by git(1) in a tar(1) archive:

$ ff type=f git.tracked=yes --sort --exec-batch tar cvzf git-tracked.tar.gz

Find files in the directory Videos/ that end with .mkv or .mp4 and are between 720 and 1080 pixels high:

$ ff Videos/ {{ ext=mkv or ext=mp4 }} and {{ height+=720 and height-=1080 }}

More examples are here.

Installation

To build and install ff simply type:

$ python setup.py install

This installs the python sources, the ff script, the man page and a set of plugins.

To build a slightly faster version of ff you can use cython:

$ CYTHONIZE=yes python setup.py install

Developing plugins and debug mode

There is a template for new plugins to start from (plugin_template.py) with exhaustive instructions and comments, so you can develop plugins for your own needs.

Useful in that regard is ff's debug mode. It can be activated by starting ff as a script using the python executable:

$ python /usr/bin/ff --debug info,cache ...

Debug mode produces lots of messages which can be limited to certain categories using the --debug category1,category2,... option. On top of that, debug mode activates many internal checks using assert(). Therefore, it is advisable to use debug mode during plugin development.

Metadata

Release files for find-ff 516

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

Source distribution (sdist)

Source distribution for find-ff 516
File Size Uploaded Provenance Actions
find-ff-516.tar.gz 51.5 kB Without provenance Details for find-ff-516.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for find-ff 516
File Interpreter ABI Platform Actions
find_ff-516-py3-none-any.whl Python 3 none any Details for find_ff-516-py3-none-any.whl

Total release size: 136.0 kB

Release files / find-ff-516.tar.gz

Download URL find-ff-516.tar.gz
Size 51.5 kB
Tags Source
SHA-256 checksum
How to use checksums
2ce7ffd013ef5810e305f251115054a926a1f168c6b9cda9beea8fcde54d2372
BLAKE2b-256 checksum
How to use checksums
32221c4692df1bee609b6606ee6c8370fc7c4a552fa5bc96f6e44684abeeb4d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

Release files / find_ff-516-py3-none-any.whl

Download URL find_ff-516-py3-none-any.whl
Size 84.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
216406a2332c7a35836ef115055881d335a7b693af348abfc1585e7a99aa4bd2
BLAKE2b-256 checksum
How to use checksums
5868f0edbfc805f995456e992c72d6eb0b2e5db384db10f0b9c49ceabd178f04
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

Security for find-ff 516

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

516 This release

2 release files No provenance

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