Skip to main content

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

img2text_cli-0.1.0.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

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

img2text_cli-0.1.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file img2text_cli-0.1.0.tar.gz.

File metadata

  • Download URL: img2text_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.13

File hashes

Hashes for img2text_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a8d1891ea83f5a761acb7e0c386111b88e7f7defbaa6edab4862a55c722c26d1
MD5 bb09a155bbc98392153d1e392c6ba8de
BLAKE2b-256 adcdf62919d2c8b0ab258cbe754704e703cf9bbafe5d67e709ae46df6620d657

See more details on using hashes here.

File details

Details for the file img2text_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for img2text_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36ce2430a70c2ff005b6ccf86b38046d33d03e7e24a9677c7c9635c40a207186
MD5 298d60604a2181b60edb2c1f28de8d85
BLAKE2b-256 3cb165b7a296652d88a65e9a61d22cb480a3d58f6fc43336b993fa765e51de5f

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