DocsChangelog

Installation & Quick Start

Install either SDK, set your API key, and start routing requests in under two minutes.

Install

Python
pip install aurex-sdk
Node.js
npm install aurex-sdk

Zero-code auto-hook

The install-hook command patches provider modules before your app imports them. See auto-hook reference for provider coverage. Environment variables are documented on /docs/installation/env-vars.

Python
# Install the hook into your site-packages
aurex install-hook

export AUREX_ENABLED=1
export AUREX_API_KEY=aux_dev_yourkey
python your_app.py
Node.js
npx aurex install-hook
source .env.aurex
export AUREX_API_KEY=aux_dev_yourkey
node your_app.js

Manual initialization

Python
from aurex_sdk import AurexAuditor, AurexConfig

auditor = AurexAuditor(AurexConfig(
    enable_loop_guard=True,
    enable_compression=True
))
auditor.patch_all()
Node.js
import { AurexAuditor } from "aurex-sdk";

const auditor = AurexAuditor.getInstance({
  enableLoopGuard: true,
  enableCompression: true
});
auditor.patchAll();

Environment variables

Full AUREX_* reference: /docs/installation/env-vars

Command Palette

Search for a command to run...