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
--re-include, --re-exclude Limit search results to specific directories or files with regex
--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.4.tar.gz (7.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-2.1.4-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pseek-2.1.4.tar.gz
  • Upload date:
  • Size: 7.1 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.4.tar.gz
Algorithm Hash digest
SHA256 62846911a5edb51a1fdba2778e50857aff09de1e9fac860040e6f4f5f2e24cb3
MD5 ecc82a73d6d753b6cc269fb1f692cd08
BLAKE2b-256 ada24cfb946cc5db176451152cba0a41e6fb59faded97b39508d1820dfc702fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pseek-2.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2de34bdacdd92e813e0e6316b9b7b162bc3d56387f97d0287fd8c7c237fa0e07
MD5 d77dd4464dcd3aa4592eafed9f426de2
BLAKE2b-256 b5b9ed8e76874c6e2f3cb90efe3c5cbb04dfefae8f3e2a0234591ca38bed4bd2

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