Installation & Authentication

Requirements

Node.js 18 or later
An active LexQ account with an API key

Installation

npm install -g @lexq/cli

npx @lexq/cli groups list

pnpm add -g @lexq/cli

Verify: lexq --version

Authentication

Step 1: Get Your API Key

Log in to the LexQ Console
Navigate to Management → API Keys
Click Generate New Key
Copy the key (format: lexq_us_xxxxxxxxxxxxx)

API keys grant full access to your organization’s policy engine. Store them securely and never commit them to version control.

Step 2: Log In

lexq auth login
# Enter your API Key: lexq_us_xxxxxxxxxxxxx
# ✓ Authenticated successfully

The key is persisted at ~/.lexq/config.json.

Step 3: Verify

lexq auth whoami

Configuration

Config is stored at ~/.lexq/config.json:

{
  "apiKey": "lexq_us_xxxxxxxxxxxxx",
  "baseUrl": "https://api.lexq.io/api/v1/partners",
  "format": "json"
}

Global Options

Every command accepts these flags:

Flag	Description
`--format <json\|table>`	Output format (default: `json`)
`--api-key <key>`	Override stored API key
`--base-url <url>`	Override API base URL
`--dry-run`	Preview the HTTP request without executing
`--verbose`	Show full request/response details
`--no-color`	Disable colored output

For AI agents: Always use --format json (the default). Parse JSON output programmatically. Use --format table only for human-readable display.

CLI

MCP Server

Installation & Authentication

Requirements

Installation

Authentication

Step 1: Get Your API Key

Step 2: Log In

Step 3: Verify

Configuration

Global Options

Next Steps

Command Reference

MCP Server

​Requirements

​Installation

​Authentication

​Step 1: Get Your API Key

​Step 2: Log In

​Step 3: Verify

​Configuration

​Global Options

​Next Steps

Command Reference

MCP Server

Requirements

Installation

Authentication

Step 1: Get Your API Key

Step 2: Log In

Step 3: Verify

Configuration

Global Options

Next Steps