Skip to content

schappim/macOCR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

macOCR

macOCR is a command line app that enables you to turn any text on your screen into text on your clipboard. When you invoke the ocr command, a "screen capture" like cursor is shown. Any text within the bounds will be converted to text.

You could invoke the app using the likes of Alfred.app, LaunchBar, Hammerspoon, Quicksilver, Raycast etc.

Examples:

An example Alfred.app workflow is available here.

If you're still wondering "how does this work?", I always find the .gif is the best way to clarify things:

How it works

Installation

Compile the code in this repo, or download a prebuilt binary (Apple Silicon, Intel) and put it on your path.

Apple Silicon Install (via Homebrew):

brew install schappim/ocr/ocr

Once installed, you can then use the macOS Shortcut Workflow (see below for details)

Apple Silicon Install (via Curl):

curl -O https://files.littlebird.com.au/ocr2.zip
unzip ocr.zip
sudo cp ocr /usr/local/bin

Intel Install:

curl -O https://files.littlebird.com.au/ocr-EPiReQzFJ5Xw9wElWMqbiBayYLVp.zip
unzip ocr-EPiReQzFJ5Xw9wElWMqbiBayYLVp.zip
sudo cp ocr /usr/local/bin

When running the app the first time, you will likely be asked to allow the app access to your screen.

Enabling access to screen

Usage

Basic Usage

Simply run ocr to interactively select a region of your screen:

ocr

The recognized text will be printed to stdout and copied to your clipboard.

Command Line Options

Option Short Description
--help Display available options
--language <code> -l Set OCR language (macOS 11+)
--list-languages List all supported OCR languages
--rect <x,y,w,h> -R Capture a specific screen region without interactive selection
--input <file> -i Use an existing image file instead of screen capture
--save-image <path> -s Save the captured screenshot to the specified path

Examples

OCR with a specific language:

ocr -l zh-Hans          # Simplified Chinese
ocr -l ja-JP            # Japanese
ocr --language de-DE    # German

List supported languages:

ocr --list-languages

Capture a specific screen region (for scripting):

ocr --rect 100,200,500,300

OCR an existing image file:

ocr --input ./screenshot.png
ocr -i ~/Documents/image.jpg

Save the captured screenshot:

ocr --save-image ~/Desktop/capture.png

Combine options:

# Capture region, save image, and use Chinese OCR
ocr --rect 0,0,800,600 --save-image ~/Desktop/shot.png -l zh-Hans

Supported Languages

On macOS 11 (Big Sur) and later, the following languages are supported:

  • en-US - English
  • fr-FR - French
  • it-IT - Italian
  • de-DE - German
  • es-ES - Spanish
  • pt-BR - Portuguese
  • zh-Hans - Simplified Chinese
  • zh-Hant - Traditional Chinese

Run ocr --list-languages to see all available languages on your system.

Add as Shortcut Workflow (Mac Monterey 12+)

  1. Open up MacOS Shortcuts available on MacOS 12+.
  2. Create new Shortcut
  3. Add Run Shell script
  4. Set input as /usr/local/bin/ocr (runs this app)
  5. Goto Shortcut Details

settings

  1. Set Pin in menubar as true

Kapture 2022-04-22 at 19 09 40

OS Support

This should run on macOS Catalina (10.15) and above. Language selection and extended language support requires macOS Big Sur (11.0) or later.

Who made this?

macOCR was made by Marcus Schappi. I create software (and even hardware) to automate ecommerce, including:

Thoughts on Sherlocking?

Apple, please sherlock this software!

MIT License

Copyright 2021 Marcus Schappi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Get any text on your screen into your clipboard.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •