Pure Javascript OCR for more than 100 Languages 📖🎉🖥
Tesseract.js is a javascript library that gets words in almost any language out of images. (Demo)
Image Recognition
Video Real-time Recognition
Tesseract.js wraps a webassembly port of the Tesseract OCR Engine. It works in the browser using webpack, esm, or plain script tags with a CDN and on the server with Node.js. After you install it, using it is as simple as:
import { createWorker } from 'tesseract.js';
(async () => {
const worker = await createWorker('eng');
const ret = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
console.log(ret.data.text);
await worker.terminate();
})();
When recognizing multiple images, users should create a worker once, run worker.recognize
for each image, and then run worker.terminate()
once at the end (rather than running the above snippet for every image).
Tesseract.js works with a <script>
tag via local copy or CDN, with webpack via npm
and on Node.js with npm/yarn
.
<!-- v5 -->
<script src='https://cdn.jsdelivr.net/npm/tesseract.js@5/dist/tesseract.min.js'></script>
After including the script the Tesseract
variable will be globally available and a worker can be created using Tesseract.createWorker
.
Alternatively, an ESM build (used with import
syntax) can be found at https://cdn.jsdelivr.net/npm/tesseract.js@5/dist/tesseract.esm.min.js
.
Requires Node.js v14 or higher
# For latest version
npm install tesseract.js
yarn add tesseract.js
# For old versions
npm install [email protected]
yarn add [email protected]
The following are examples and projects built by the community using Tesseract.js. Officially supported examples are found in the examples directory.
blocks
output to generate granular data [word/symbol level]: https://github.com/Kishlay-notabot/tesseract-bbox-examples
If you have a project or example repo that uses Tesseract.js, feel free to add it to this list using a pull request. Examples submitted should be well documented such that new users can run them; projects should be functional and actively maintained.
Version 5 changes are documented in this issue. Highlights are below.
createWorker
arguments changed
createWorker
createWorker("chi_sim", 1)
worker.initialize
and worker.loadLanguage
functions now do nothing and can be deleted from codeUpgrading from v2 to v5? See this guide.
Version 4 includes many new features and bug fixes--see this issue for a full list. Several highlights are below.
createWorker
is now asyncgetPDF
function replaced by pdf
recognize optionTo run a development copy of Tesseract.js do the following:
# First we clone the repository
git clone https://github.com/naptha/tesseract.js.git
cd tesseract.js
# Then we install the dependencies
npm install
# And finally we start the development server
npm start
The development server will be available at http://localhost:3000/examples/browser/basic-efficient.html in your favorite browser.
It will automatically rebuild tesseract.min.js
and worker.min.js
when you change files in the src folder.
You can use Gitpod(A free online VS Code like IDE) for contributing. With a single click it will launch a ready to code workspace with the build & start scripts already in process and within a few seconds it will spin up the dev server so that you can start contributing straight away without wasting any time.
To build the compiled static files just execute the following:
npm run build
This will output the files into the dist
directory.
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]