docs → tools → windsurf

Frenchie in Windsurf

Natural language. User-level install.

⚠️ Not yet smoke-tested on a live install — content below is the expected shape, pending verification. If you hit anything that doesn't match this guide, email support@getfrenchie.dev so we can correct it.

Install

From your project root:

npx @lab94/frenchie install --agent windsurf --global --api-key fr_your_key_here

Need help picking an agent? See the invocation matrix.

Invoke

Primary pattern:

OCR TOR.pdf via Frenchie

Not yet verified on a live Windsurf install — invocation pattern above is the expected shape.

Example

You:

OCR TOR.pdf via Frenchie

Agent:

Windsurf is expected to call ocr_to_markdown via natural-language routing. Smoke test TBD.

Known gotchas

GUI PATH gap may apply

Windsurf is a desktop app, so the same GUI PATH inheritance gap that breaks Antigravity may apply. 0.3.0's absolute-path install should prevent it, but smoke testing is still pending.

Cross-reference: /docs/troubleshooting#npx-not-found

Main Frenchie docs — MCP tools, credits, rate limits, full API
All agent guides — the full invocation matrix
Troubleshooting — symptom-first fixes for every error we've seen
Migration guide — upgrading from 0.1.x, 0.2.x, 0.3.0, or 0.3.1