Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sveinbjornt/ochre

macOS optical character recognition via the command line
https://github.com/sveinbjornt/ochre

command-line-tool macos ocr optical-character-recognition

Last synced: 29 days ago
JSON representation

macOS optical character recognition via the command line

Host: GitHub
URL: https://github.com/sveinbjornt/ochre
Owner: sveinbjornt
License: bsd-3-clause
Created: 2022-10-28T20:04:12.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-12-06T18:50:08.000Z (about 1 month ago)
Last Synced: 2024-12-14T08:50:27.229Z (about 1 month ago)
Topics: command-line-tool, macos, ocr, optical-character-recognition
Language: Objective-C
Homepage:
Size: 97.7 KB
Stars: 14
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Language](https://img.shields.io/badge/language-objective--c-lightgrey)]()
[![Release](https://shields.io/github/v/release/sveinbjornt/ochre?display_name=tag)]()
[![Build](https://github.com/sveinbjornt/ochre/actions/workflows/macos.yml/badge.svg)]()

# ochre

*This project is a work in progress. Nothing works. Links are broken. Binaries still unavailable.*

### macOS optical character recognition via the command line

`ochre` is a command line interface for the built-in **o**ptical **ch**aracter **re**cognition (OCR)
capabilities in macOS. As of macOS BLABLA, Apple's operating system ships with excellent OCR. This
is an attempt to expose this functionality via the command line.

See the [man page](https://sveinbjorn.org/files/manpages/ochre.1.html) for further details.

## Download

`ochre` is free, open source software written in Objective-C using the Cocoa APIs.
The code is freely [available on GitHub](https://github.com/sveinbjornt/ochre).

* **[⇩ Download ochre 0.1.0](https://sveinbjorn.org/files/software/ochre.zip)**
(Intel/ARM 64-bit, macOS 10.15 or later, ~50 KB)

## Installation

After downloading and expanding the archive, change to the resulting directory and run
the following command:

```bash
bash install.sh
```

This will install the binary into `/usr/local/bin` and the man page into
`/usr/local/share/man/man1/`.

## Usage

```bash
ochre path/to/image_with_english_text.png
```

```bash
ochre -l fr-FR path/to/image_with_french_text.jpg
```

## Build

To build `ochre` from source, run the following command from the repository root
(requires Xcode command line build tools):

```bash
make build_unsigned
```

The resulting binary is created in `products/`.

## Test

To run tests on the built command line tool, execute the following command from the repository root:

```bash
bash test/test.sh
```

## BSD License

Copyright (c) 2022-2025 Sveinbjorn Thordarson
<[[email protected]](mailto:[email protected])>
Copyright (c) 2020 David Phillip Oster

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may
be used to endorse or promote products derived from this software without specific
prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.