Skip to main content

SQL-like interface for querying files in your filesystem

Project description

File Query

A SQL-like interface for querying files in your filesystem.

Installation

# Clone the repository
git clone https://github.com/yourusername/file-query.git
cd file-query

# Install with pip
pip install -e .

# Or use UV
uv run python -m src.cli "your query"

# Install as a permanent tool with UV
uv tool install .
# This will install the 'fq' command

Usage

Command Line

The quickest way to run file-query is with UV:

uv run python -m src.cli "your query here"

After installation, you can use the shorthand command:

fq "your query here"

Basic Usage

# Find all Python files
fq "extension == 'py'"

# Find all text files and show their content
fq "extension == 'txt'" --show-content

Advanced Queries

File Query supports full SQL-like syntax:

# Find all Python files in the src directory
fq "SELECT * FROM 'src' WHERE extension == 'py'"

# Find all files larger than 100KB
fq "SELECT * FROM '.' WHERE size > 102400"

# Complex conditions
fq "SELECT * FROM '.' WHERE (extension == 'pdf' AND size > 1000000) OR (extension == 'txt' AND NOT name == 'README.txt')"

Query Syntax

File Query uses a SQL-like syntax:

SELECT * FROM 'directory_path' WHERE condition

Available Attributes

  • extension: File extension (without the dot)
  • name: Filename with extension
  • size: File size in bytes
  • path: Full file path

Operators

  • Comparison: ==, !=, <, <=, >, >=
  • Logical: AND, OR, NOT

Examples

# Find all PDF files
fq "extension == 'pdf'"

# Find all files not named "main.py"
fq "NOT name == 'main.py'"

# Find all large image files
fq "SELECT * FROM '.' WHERE (extension == 'jpg' OR extension == 'png') AND size > 500000"

# Find files with 'config' in their path
fq "path == '.*config.*'"

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

file_query_text-0.1.7.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

file_query_text-0.1.7-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file file_query_text-0.1.7.tar.gz.

File metadata

  • Download URL: file_query_text-0.1.7.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.2

File hashes

Hashes for file_query_text-0.1.7.tar.gz
Algorithm Hash digest
SHA256 572c9547c68505ae11278737b35301d7691d90fe36f3be55af9e6f4bf9d8402a
MD5 7219649dbaf7991a7a531e9a6fc17bb5
BLAKE2b-256 5b284c3e8482ae0ef31487a61ecd9ddc46b7eb4bd76a7aba12558f8901b0f4fe

See more details on using hashes here.

File details

Details for the file file_query_text-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for file_query_text-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 264a2709b8a44e26f9953719eca567eee22afbf86ce8df4aadb306742656df32
MD5 0f267d4553e6239efe3d897ee8478d4d
BLAKE2b-256 c2121b07aebd2d40b6a4fce0a477eb0412987c40bbb8f00aecf16bdf6bbff10e

See more details on using hashes here.

Supported by

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