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, --exclude-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-2.1.2.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

pseek-2.1.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pseek-2.1.2.tar.gz
Algorithm Hash digest
SHA256 09dcc0e1bb2740fe0daae1a63449636ae1243be3cffdaec796c44d8c44ba01eb
MD5 8fff209790e7cf7f3055fa9fe13bfe73
BLAKE2b-256 932514e82a10bf0f105508dcb5d5b289f11672965867b31863bfe1ab2df1f668

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pseek-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 059752f6c4125e01ad75ab7b4e3b650a98019bca29410784cded422d71b6acb5
MD5 7bba1d5287ab660b8fb72f0b3cd3af4d
BLAKE2b-256 083244c09b01ce5ff05c499e32f37dc5afb64a1087ffaa84bc1eaddd67dad664

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