Sygal CLI
Convert documents to Markdown,
from your terminal.
The same local-first engine as the Sygal desktop app, headless and scriptable, built for developers and AI agents.
Documents are converted on your machine. An image or scan goes through the OCR provider you choose, with your own key.
Install
npm install -g sygal-cliAvailable for macOS, Windows and Linux, same command everywhere.
14-day free trial
One command,
three platforms.
npm installs the right native conversion engine for your platform automatically.
Then install Sygal
npm install -g sygal-cliInstalls the sygal command globally, ready to use from any folder.
macOS
Apple Silicon native binary, installed automatically.
Windows
Windows x64 native binary, installed automatically.
Linux
Linux x64 native binary. Requires glibc 2.28+ (Ubuntu 18.04+, Debian 10+, RHEL 8+, Amazon Linux 2+). Not compatible with Alpine/musl, use a glibc-based image for containers.
Same 29 formats and the same local processing as the desktop app: documents stay on your machine, images and scans go through the OCR provider you choose, with your own key. See the details.
The commands
you'll actually use.
Real commands from the README.
These commands run from the folder containing your file. You can also give a full path, for example sygal convert ~/Desktop/report.pdf.
sygal convert report.pdfConvert a single file. Output written next to the source.
sygal convert folder/ --format both -o ./outputConvert a whole folder recursively, output both .md and .json.
sygal convert https://example.com/articleConvert a web page straight to Markdown.
sygal convert scan.pdf --pdf-ocr allScanned PDF, OCR every page.
sygal convert doc.docx --advancedAlso OCR the images embedded inside the document.
sygal convert note.txt --translate enTranslate the converted output.
Configuration and licence
sygal config set-ocr-provider openaiChoose your OCR provider: OpenAI, Mistral, Claude, NVIDIA NIM or Gemini.
sygal config set-api-key openaiSet your API key, read from stdin, encrypted at rest, bound to your machine.
sygal license activate <key>Activate, check, or release your licence.
sygal updateUpdate the CLI via npm.
Built for humans
and for agents.
Strict machine-readable output and stable error codes, designed for agent pipelines like Hermes or OpenClaw.
Strict JSON output
sygal convert folder/ --jsonExit code 1 on failure, stable error codes: unsupported_format, api_key_missing, invalid_api_key, rate_limited, network_error, model_deprecated, scanned_pdf_detected, ocr_call_limit_exceeded, license_expired, sidecar_down, timeout and more. Each file also reports networkUsed (true or false), so an agent can check whether anything left the machine, plus the pipeline and OCR provider used.
Deferred OCR, zero API calls
sygal convert doc.docx --advanced --ocr defer --jsonsygal inject doc.docx.md --transcripts transcriptions.jsonFor agents that can read images themselves. Extracted images are saved next to the source, markers mark their position in the Markdown, and the JSON output lists every deferred image with its index, path and page. sygal inject then puts each transcription back exactly where it belongs.
One licence.
One seat, either side.
Try free for 14 days, no card needed. Then a one-time purchase, no subscription, ever.
Sygal CLI
1 seat
- 1 activation, on the CLI or the desktop app, never both at the same time; switch anytime
- CLI: macOS (Apple Silicon), Windows, Linux
- Convert PDF, Word, Excel, PowerPoint, images and web pages
- OCR with your own API key (BYOK) and batch export
- Updates included for the major version
- 14-day free trial before purchase
- Refund available within 14 days
Sygal Solo + CLI
Recommended- 2 activations: app or CLI, your choice
- Desktop app (macOS, Windows) + CLI
- Licence for 2 seats, usable on both desktop and CLI
- All features: conversion, OCR (BYOK), library, batch export
- Updates included for the major version
- 14-day free trial before purchase
- Refund available within 14 days
Complete guide and agent skill, free to download, no email required.