§ docs

CLI

@nymanmedia/ai-visibility-cli wraps the public REST API so you can run audits from a terminal or a CI/CD pipeline. It talks to the same engine as the web app and shares the same daily quota. See the CLI landing for the developer-focused overview.

Install

# Install globally
npm install -g @nymanmedia/ai-visibility-cli

# Or run ad-hoc with npx
npx @nymanmedia/ai-visibility-cli audit https://example.com

Requires Node.js 20.11 or newer.

Authenticate

Create an API key under Account settings → API access on the web app (requires a Premium subscription), then:

nmav login

The key is stored at ~/.config/nmav/config.json (or $XDG_CONFIG_HOME/nmav/config.json) with mode 0600. For CI, set NMAV_API_KEY as an environment variable instead; login is not needed.

Commands

nmav audit <url> [--fail-on-score N] [--json] [--output file] [--country us]
nmav whoami
nmav login

audit

--fail-on-score N: exit non-zero when the audit score is below N. Use this to gate deploys.
--json: emit the raw API response instead of the table.
--output path: write the rendered output to a file.
--country us: ISO 3166-1 alpha-2 code for localized checks.

whoami

Prints the email, tier, and remaining daily quota for the current API key.

Exit codes

0: success.
1: generic error.
2: usage error (missing argument, bad flag).
3: rate-limited (HTTP 429).
4: --fail-on-score threshold not met.

CI example

- name: AI visibility audit
  env:
    NMAV_API_KEY: ${{ secrets.NMAV_API_KEY }}
  run: |
    npx -y @nymanmedia/ai-visibility-cli audit "$PREVIEW_URL" \
      --fail-on-score 70 --json > audit.json

See CI/CD recipes for GitLab and CircleCI variants.

Driving audits from an AI agent

The same engine is available to MCP-capable clients (Claude Desktop, Cursor, ChatGPT desktop, Claude API connectors). Same key, same quota. See MCP server.

Self-host or staging

Point the CLI at a different host with --api-base or NMAV_API_BASE:

nmav audit https://example.com --api-base https://staging.nyman.media