A CLI tool to extract text from images using OCR
Project description
img2text-cli
A powerful command-line tool to extract text from images using OCR (Optical Character Recognition).
Features
- 🖼️ Image to Text: Convert image files to text using Tesseract OCR
- 📋 Clipboard Support: Extract text directly from clipboard images
- 🔄 Piping Support: Process images from stdin for automation
- ⚡ Fast & Efficient: Built with Python and optimized for performance
- 🎯 Simple CLI: Easy-to-use command-line interface
Installation
From PyPI (Recommended)
pip install img2text-cli
Prerequisites
This tool requires Tesseract OCR to be installed on your system. For detailed installation instructions, visit the official Tesseract installation guide.
Usage
Basic Usage
Extract text from an image file:
img2text image.png
Piping Images
Process images from stdin:
cat image.png | img2text
Clipboard Image
Extract text from an image in your clipboard:
img2text --clip
Help
Get help and see all options:
img2text --help
Examples
# Extract text from a local image file
$ img2text document.png
This is the extracted text from the image...
# Process clipboard image
$ img2text --clip
# Text is automatically copied to clipboard
# Use with other tools
$ ls *.png | xargs -I {} img2text {}
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the GNU General Public License v3 (GPLv3) - see the LICENSE file for details.
Acknowledgments
- Tesseract OCR - The OCR engine
- Click - Command line interface creation kit
- Pillow - Python Imaging Library
- pyperclip - Cross-platform clipboard operations for text
- pyperclipimg - Cross-platform clipboard operations for images
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file img2text_cli-0.1.7.tar.gz.
File metadata
- Download URL: img2text_cli-0.1.7.tar.gz
- Upload date:
- Size: 51.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ca5ff5ea1c2c7c07a8a758151c1d2a62f498c0bfb69acafd683ae1f4247e9e15
|
|
| MD5 |
941c8e53abc8560d141e72f0a587414c
|
|
| BLAKE2b-256 |
12d11b9a33c20151f8a9de4d13980ba21469531e0adf72801faf2545a2b086b6
|
File details
Details for the file img2text_cli-0.1.7-py3-none-any.whl.
File metadata
- Download URL: img2text_cli-0.1.7-py3-none-any.whl
- Upload date:
- Size: 3.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b939955bf0c084dff7759cdad7fed3a5b5c6c67ff6b5b369790f88f12a7adbd5
|
|
| MD5 |
27858a7d5201d6e0a85536672b555b59
|
|
| BLAKE2b-256 |
977236829a1543721a0f2a508215b39088b8c1a42ec9f80fc9831a0ead768d6b
|