Skip to main content

aris test

Validate your API key and test connectivity to all ARIS endpoints.
npx @aris/cli test

Checks performed

  1. API key — validates against the ARIS API
  2. Brokerage — confirms brokerage name and config
  3. Widget config — fetches colors, position, and style
  4. Listings search — tests the MLS search endpoint
  5. Featured listings — tests the featured listings endpoint

Example output

aris test — Verify your ARIS connection

  ✓ API key: Valid
  ✓ Brokerage: Acme Realty
  ✓ Widget config: color: #1e3a8a, position: bottom-right, style: rounded
  ✓ Listings search: 847 listings accessible
  ✓ Featured listings: 12 featured listings

All 5 checks passed.

API key: aris_abc...xyz0
Endpoint: https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router

Exit codes

CodeMeaning
0All checks passed
1One or more checks failed
Use in CI/CD pipelines:
npx @aris/cli test || echo "ARIS connection check failed"