CL-OCRSpaceis OCRSpace API on the command line.
OCRSpace API - A powerful Online OCR service that converts images of text documents into editable files by using Optical Character Recognition (OCR)
1. To use this, register for your free OCR API key at https://rb.gy/xbimy0
2. This program requires an active internet connection.
3. This program is indipendent and unofficial, This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by OCRSpace.
4. This program relies heavily on the OCRSpace API endpoint. Check the API performance and uptime at the API status page : https://status.ocr.space/
Add to path or alternatively execute it in the directory containing CL-OCRSpace.exe.
Running CL-OCRSpace.exe -v should print the program version information to the standard output.
| Parameter | Description | Input type | Default Value |
|---|---|---|---|
-h |
Print help information and exit. | none | none |
-v |
Print the version number and exit. | none | none |
-k |
Specify an API key to use. Retrieve a Key from https://rb.gy/xbimy0 | string | Null |
-e |
Specify the OCR Engine to use. Allowed args are 1 and 2 CL-OCRSpace.exe "Receipt.png" -e 2 /ov |
integer | 1 |
-l |
Define the Output Language using its ISO 639-2 langauge code. CL-OCRSpace.exe "Receipt.png" -l eng |
string | eng |
-s |
Specify a separator character when overlay flag /ov is used.CL-OCRSpace.exe "Receipt.png" -s "#" /ov |
string | "|" |
| Switch | Switch description | Input Type | Default Value |
/pf |
Request a searchable PDF and return its direct URL. This switch overrides printing detected text to stdOut. CL-OCRSpace.exe "Receipt.png" /pf |
none | False |
/ov |
Return the scanned text with delimited coordinates of the bounding boxes for each word detected, in the format (#Word|#Left|#TopPos|#Height|#Width). |
none | False |
/as |
Allow Image upscaling. Useful for low-resolution Image and PDF scans. CL-OCRSpace.exe "Receipt.png" -e 2 /as |
none | False |
/tl |
Use table logic for scanning (table recognition). The parsed text result is returned line by line. Best for table OCR, receipt OCR, invoice processing and any other tabular document processing.CL-OCRSpace.exe "Receipt.png" /tl |
none | False |
/do |
Allow auto-detecting text orientation and auto-rotate (if needed). If this flag is unissued, processing is done as is. CL-OCRSpace.exe "Receipt.png" /do |
none | True |
/pt |
Allow a PDF text layer. Relevant when a PDF is requested with '/pf' switch. CL-OCRSpace.exe "Receipt.png" /pf /pt |
none | False |
/vm |
Allow standard output verbosity mode. CL-OCRSpace.exe "Receipt.png" /vm |
none | False |
/dm |
Allow running in debug mode. Logs are written to CL-OCRSpace.log CL-OCRSpace.exe "Receipt.png" /dm |
none | False |
- UNC paths are supported. A file name/path containing spaces need to be wrapped with double quotes. Otherwise it is rendered as an invalid URL/PATH to parse. Supported filetypes are PNG, GIF, PNG, JPG, TIF, BMP, JPEG & PDF.
- Engine 1 (DEFAULT) is Faster , also supports Asian languages (i.e Chinese, Japanese, Korean), larger images & Multi-Page TIFF scans.
- Engine 2 supports Western Latin Character languages only (English, German, French, etc), has Language auto-detection for Latin character languages, better at single number OCR/Single character OCR/Alphanumeric OCR in general, better at special characters OCR like @+-, and better with rotated text. Image size limit is 5000px width and 5000px height.
- Flags are not case sensitive.
0 - Success
1 - Error : APIKey Invalid/unprovided.
2 - Error : No internet connection.
5 - Error : Unsupported filetype provided.
6 - Error : Unsupported file provided. See Remarks.