Docs

The Medawar command-line tool

Install it with pipx install medawar (or uv tool install medawar), run medawar login, then medawar review paper.pdf. The review runs on Medawar's servers; the tool keeps each paper's extraction and findings on your machine.

Install and sign in

pipx install medawar
medawar login

medawar login prints a short code and a link. Open the link, enter your email and the code, confirm from the email you receive, and the terminal is signed in. On a server without a browser, create an API token on your account page and run medawar login --token <token>.

Review a paper

medawar review paper.pdf
medawar review thesis/ --only language,referencing
medawar review paper.tex --report review.html

The paper can be a file (PDF, Word (.docx), LaTeX, Markdown and plain text), a LaTeX project folder, or an Overleaf project link (run medawar login overleaf first). --only runs the checks you name; --json prints the full result; --report writes an HTML or PDF report.

Findings and the local cache

medawar findings paper.pdf
medawar skills
medawar cache path
medawar cache clear

Each paper is cached by a hash of its content (every file of a LaTeX project). medawar findings shows the latest result of each check without a network call. A second review --only reuses the cached extraction instead of sending the paper again. medawar skills lists the checks the server offers.

Frequently asked questions

Does the command-line tool work offline?

No. Reviews run on Medawar's servers. Findings you already have stay readable offline with medawar findings.

Does it use my review credits?

Yes, the same credits as the web app: 11 for a full review, 1 to 3 per check for a selection, and 1 to extract a paper on its own with medawar extract. Uploading a paper in the web app uses none. medawar skills lists each check's credits.

Keep reading