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.5.tar.gz (51.2 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.5-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for img2text_cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ab77d75bfa5b02ebb40f7ad32c5bb68565ba86e30e97cadfb5656324b51647d5
MD5 1e242c27449bde83a7f07e90998715c4
BLAKE2b-256 0665f8399cec3c2de3240e379232b432977bc9c2a82e4b1851463bd32fad7d18

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for img2text_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e1f766eae7865a798bc32c2e2cb0ba1dc8801479df40128006217ccfd1d5e8
MD5 2a58e7612cc70d07787c6038ef0e3266
BLAKE2b-256 6aaaafe15a1d4df28e06192c8a24f96140ae44de2fdf856777b0a3e283d42c3a

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