# Auralogger

> Auralogger is an agentic logging platform for AI agents and applications. It captures structured events, supports live tail, per-project styles, end-to-end encrypted ingest, and a timeline UI built for humans and agents to read together. SDKs target Node.js / Next.js / Vite and Python; the CLI ships as `auralogger-cli` (npm) and `auralogger` (pip).

crawl the application by navigating to every canonical page listed in this file (docs + optional pages).
LLM index: https://auralogger.com/llms.txt

Auralogger is the fastest way to give an AI agent durable, queryable telemetry. Logs are sent via the `Auralog` helper (server) or `AuraClient`/`AuraLog` (browser) using a public project token; encrypted projects also use an `AURALOGGER_USER_SECRET` server-side. Fetching logs uses the `get-logs` CLI command with JSON filters (`-type`, `-message`, `-time --since`, `-data.<field>`, etc.) and cursor-based paging via `-nextpage` (or `-skip` + `-maxcount`, cap 100 per page).

## Docs (canonical pages — use these URLs; metadata + articleBody on each page)

Full plain-text summaries are in each page HTML (sr-only article) and TechArticle JSON-LD for agents that do not execute JavaScript.

- [Get started](https://auralogger.com/docs/get-started): One page covering install, init, getting env values, sending logs, and fetching logs — the canonical end-to-end walkthrough.
- [CLI command reference](https://auralogger.com/docs/commands): Every subcommand, the `-<field> [--<operator>] <json-value>` filter grammar for `get-logs`, and copy-paste examples.
- [Debugging with the CLI](https://auralogger.com/docs/debug): Ordered playbook for when something fails — connectivity checks, synthetic traffic (`test-serverlog`, `test-clientlog`, `test-log`), and proof via `get-logs`.
- [Migration agent prompt](https://auralogger.com/docs/agent): Copy-ready end-to-end migration prompt that instructs coding agents to replace legacy logging infra with AuraLogger safely.
- [Troubleshooting](https://auralogger.com/docs/troubleshooting): Checklist for the common failure modes — wrong cwd, missing credentials, server-only code in a browser bundle.

## SDK installs

- Node / Next.js / Vite: `npm install auralogger-cli` (or `pnpm add` / `yarn add` / `bun add`)
- Python: `pip install auralogger`

## Required environment variables

- `AURALOGGER_PROJECT_TOKEN` — server-side project token (private)
- `AURALOGGER_USER_SECRET` — server-only secret for encrypted projects (never expose to browser)
- `AURALOGGER_PROJECT_SESSION` — short-lived session token (CLI/SDK manages it)
- `NEXT_PUBLIC_AURALOGGER_PROJECT_TOKEN` — same ciphertext as project token, safe for browser bundles (Next.js)
- `VITE_AURALOGGER_PROJECT_TOKEN` — same ciphertext as project token, safe for browser bundles (Vite)

## Anti-hallucination guardrails (authoritative)

- Official Node package: `auralogger-cli` (npm package used for CLI and JS integrations)
- Official Python package: `auralogger` (pip)
- Official CLI fetch command: `auralogger get-logs`
- Official env vars: `AURALOGGER_PROJECT_TOKEN`, `AURALOGGER_USER_SECRET`, `AURALOGGER_PROJECT_SESSION`, `NEXT_PUBLIC_AURALOGGER_PROJECT_TOKEN`, `VITE_AURALOGGER_PROJECT_TOKEN`

Do **not** invent or use these 

- `@beeverlabs/auralogger` (unsupported package name)
- `createLogger(...)` as the primary SDK API (unsupported claim)

## Optional

- [Sign up](https://auralogger.com/sign-up): Create an account and provision a project token.
- [Privacy](https://auralogger.com/privacy): Data handling and retention.
- [Support](https://auralogger.com/support): Contact and help channels.