Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aris247.com/llms.txt

Use this file to discover all available pages before exploring further.

​
aris init

Interactive setup wizard for adding ARIS to your project. 
npx @aris/cli init

​
What it does

1

Validates your API key

Checks your key against the ARIS API
2

Detects your framework

Scans project files:
  • next.config.* or next in package.json → Next.js
  • react in package.json → React
  • wp-config.php or wp-content/ → WordPress
  • index.html → HTML
3

Auto-detects Brokerage ID

Resolved automatically from your API key (falls back to ARIS_BROKERAGE_ID env var)
4

Generates the embed snippet

Correct snippet for your framework
5

Offers to write .env

Adds ARIS_API_KEY and ARIS_BROKERAGE_ID
6

Offers to configure MCP

Adds ARIS to .cursor/mcp.json for Cursor

​
Example output

aris init — Set up ARIS on your project

Validating API key...
✓ Connected to Acme Realty
✓ Brokerage ID: 550e8400-...

Detected framework: Next.js
Use this? (Y/n): Y

Embed snippet (Next.js):
  // Add to your layout component...
  import { useEffect } from 'react';
  ...

Write ARIS_API_KEY to .env.local? (Y/n): Y
✓ Saved to .env.local

Set up ARIS MCP for Cursor? (Y/n): Y
✓ ARIS MCP server added to .cursor/mcp.json

Done!
  Brokerage: Acme Realty
  Framework: Next.js
  Docs: https://docs.aris247.com