Quickstart

Install the CLI and check your first piece against a real label.

1. Install

   Open Label needs Node 22 or later.

   git clone https://github.com/amanibobo/openlabel
   cd openlabel
   npm install
   npm link -w openlabel
   

   npm link puts the openlabel command on your path. Without it, run npx openlabel from the repo.

2. Add a model key

   Check and the plain-language form of Unseen call a model. Put a key in a .env file in the directory you run the command from. Claude is the default:

   echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
   

   Any provider with an OpenAI-style API works too, with a model id:

   echo "OPENROUTER_API_KEY=sk-or-..." > .env
   echo "OPENLABEL_MODEL=<model id from openrouter.ai/models>" >> .env
   

   .env is in .gitignore. Search, diff, watch and Unseen with flags need no key. See Models and providers.

3. Check a piece

   The repo ships an example HCP email for Dupixent.

   openlabel check examples/dupixent-email.html --label dupixent
   

   Dupixent (dupilumab) · label v60 · 5 claims
   
     ✓ supported    “38% of adults achieved clear or almost-clear skin (IGA 0 or 1) at Week 16, compared with 10% on placebo”  §14.1 ¶5, §14.1 ¶12
                    Table 18 reports IGA 0 or 1 at Week 16 in 38% of DUPIXENT-treated adults with
                    moderate-to-severe atopic dermatitis versus 10% on placebo, which matches the claim.
     ~ overstated   “Now approved for chronic hives in children as young as 2”  §1.7 ¶1, §1.7 ¶3
                    The label approves Dupixent from age 2 only for chronic spontaneous urticaria that
                    stays symptomatic despite H1 antihistamines and excludes other forms of urticaria.
     ...
   
     3 overstated · 2 supported · 1 rule finding · exit 1
   
4. Look something up

   openlabel search dupixent "conjunctivitis and keratitis"
   openlabel diff dupixent --from 53
   

Labels are cached under ~/.cache/openlabel/labels by set id and version, so a second run against the same label makes no network request for it.

To preview these docs while editing them, run npm run docs from the repo root.