Skip to main content

Pseek is a Python library to search files, folders, and text

Project description

Pseek

Overview

A powerful command-line tool for searching files, directories, and content inside files efficiently. The tool supports searching by name, content, extensions, and more with advanced filtering options.

Features

  • Search in file & folder names
  • Search inside file contents
  • Highlight matches in terminal output
  • Optimized for speed with ThreadPoolExecutor
  • Cross-platform (Linux, macOS, Windows)

Installation

1️⃣ Install via pip (Recommended)

pip install pseek

2️⃣ Install from source

git clone https://github.com/ArianN8610/pysearch.git
cd pseek
pip install click==8.1.8

Usage

Run the command with a search query:

pseek <query> [options]

Examples

Search for a keyword in file & folder names

pseek "my_keyword" --path /path/to/search --file --directory

Search inside file contents

pseek "error" --path /var/logs --content

Search only in specific file types

pseek "TODO" --path ./projects --ext py --ext txt

Search by regex

pseek "error\d+" --regex

Command Options

Option Description
--path Base directory to search in (default: current directory .)
--file Search only in file names
--directory Search only in directory names
--content Search inside file contents
--ext Filter by file extension (e.g., .txt, .log)
--case-sensitive Make the search case-sensitive
--regex Use regular expression for searching
--include, --exclude Limit search results to specific set of directories or files
--word Match the whole word only
--max-size, --min-size Specify maximum and minimum sizes for files and directories
--full-path Display full path of files and directories

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

pseek-1.0.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

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

pseek-1.0.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file pseek-1.0.1.tar.gz.

File metadata

  • Download URL: pseek-1.0.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for pseek-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4742e676e25fab97e33157dc0d0b2625079c67ccdab7bd8b5a7d9c89ddaf801e
MD5 75cf2dd1f779df0a172e9ec6a7b0050e
BLAKE2b-256 1f306304d2790856a4ce914525de6da5445a2dc46b839d663fb0a8140d8eb21d

See more details on using hashes here.

File details

Details for the file pseek-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pseek-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for pseek-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e326ba9950c74b31cec50bcf7733398cc021e2858f2f78aab00f3be8f3382ca
MD5 4dc352f58e8f944797e2738f2eb7afb1
BLAKE2b-256 8a0d78b01b66c212a5019511ce9d7cab68c8fbb5947efcaab7d227642346a35d

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