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
--no-content Only display files path for content search

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.3.tar.gz (6.9 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.3-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pseek-2.1.3.tar.gz
  • Upload date:
  • Size: 6.9 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.3.tar.gz
Algorithm Hash digest
SHA256 0c213ffc9809e86c5f2c402e84d626a46b69943ca00bc37cd441c6a7d17fe33d
MD5 0fdeb353d99cc3786fc23696355598e2
BLAKE2b-256 4f7845da2b5a0282519d4068166c242a78d724bae537e98fcecbcc1ae06b6661

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pseek-2.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 529ae006882a37ef4d3a80756e3e0e05115c996ad881d670f671843a9e3537d1
MD5 63529e4f28fa9873113a044a2823465e
BLAKE2b-256 145053946af4190f798fbbdcad0f9e2515bf05c966617ab30369cd646c4ba979

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