CLI Overview

The MidLyr CLI is the fastest way to test API calls, script compliance workflows, and debug agent integrations outside of an application runtime.

Use the CLI when you need to:

• Browse the regulatory library.
• Read a regulatory document.
• Query raw source-ready chunks.
• Submit a compliance-screening analysis job.
• Retrieve job status and results.

Install

npm install -g @midlyr/cli

Authenticate with an API key:

export MIDLYR_API_KEY="ml_..."

Common Commands

midlyr regulations browse --query "provisional credit"
midlyr regulations read 01HXZ3K4M7QR9VP2N8WYJF5GTB
midlyr regulations query --query "provisional credit error resolution"
midlyr analysis screen --text "we can't provide a provisional dispute credit until the investigation is completed"
midlyr jobs get job_01HY3K4M7QR9VP2N8WYJF5GTB

Next Steps

• CLI Commands
• Screen Analysis API
• Jobs API