Docs · Install

Get started with Sunaiva Gate.

Two paths: npm (manual settings.json) or the CLI binary (coming soon). Free tier requires no account and no API key — 34 local rules run entirely on your machine.


Option A — npm (manual settings.json)

Install the npm package globally, then add the mcpServers entry to your host config.

$npm install -g @sunaiva/gate

Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json) or Claude Code settings (~/.claude/settings.json):

{
  "mcpServers": {
    "sunaiva-gate": {
      "command": "sunaiva-gate",
      "env": {
        "SUNAIVA_GATE_API_KEY": "<your-sgk_live_... key>"
      }
    }
  }
}

Free tier: omit SUNAIVA_GATE_API_KEY entirely — 34 local rules run without it. The key unlocks 69 additional server-side rules on paid tiers.

Two ways to run Gate: local process, or remote MCP. The npm install above runs the Gate as a local stdio process on your machine — the free tier's 34 rules are evaluated fully offline, with the backend contacted only for premium rule sync on paid tiers. Separately, https://mcp.sunaivacore.io is also reachable directly as a remote streamable-http MCP transport (no local install) — initialize/tools/list/ping are unauthenticated; only tools/call requires an API key. See llms.txt for the remote-transport tool list.

Option B — CLI binary (coming soon)

The sunaiva-gate CLI binary will provide account management, rule-mode configuration, custom-rule CRUD, audit log access, and observability event streaming — a companion to the MCP server, not a replacement.

Not yet available via npm. The dashboard will surface it once the binary ships.

Getting an API key

Sign up at dashboard.sunaivacore.io. Your free API key (sgk_dev_ prefix) is generated on account creation — no credit card required. Paid tiers (Pro / Team / Enterprise) issue a sgk_live_ key on upgrade.

Visit dashboard.sunaivacore.io and create a free account.
Copy your API key from the Settings → API Keys panel.
Set SUNAIVA_GATE_API_KEY=sgk_dev_... in your environment or MCP host config.
On paid tiers, the Gate downloads your 69 premium rules on first authenticated startup. The free tier runs the 34 local rules — no download needed.

Verify the install

$npx @sunaiva/gate --smoke-test

Exit 0 = HEALTHY. Checks rule loading, credential location, and connectivity to mcp.sunaivacore.io/v1/health.