Auralogger CLI commands — init, checks, test logs, get-logs filters

Full auralogger-cli reference: init, server-check, client-check, test-serverlog, test-clientlog, test-log, get-logs. JSON filter grammar -field [--operator] value, operators --not-in and --since, paging with -nextpage, -skip, -maxcount (max 100).

CLI command reference
Invocation:
auralogger <command> [arguments...]

Filter grammar for get-logs:
-<field> [--<operator>] <json-value>

Main commands
- init:
  - Performs proj_auth and prints dotenv lines/snippets.
  - Variables include AURALOGGER_PROJECT_TOKEN, AURALOGGER_USER_SECRET, AURALOGGER_PROJECT_SESSION,
    NEXT_PUBLIC_AURALOGGER_PROJECT_TOKEN, VITE_AURALOGGER_PROJECT_TOKEN.
- server-check:
  - Validates server WebSocket connectivity and server credentials.
- client-check:
  - Validates browser logging socket path and session context resolution.
- test-serverlog:
  - Sends synthetic server logs through AuraServer path.
- test-clientlog:
  - Sends synthetic client logs through AuraClient path.
- test-log:
  - Smoke-test style client logging path.
- get-logs:
  - Fetches logs with filters and one-page-at-a-time paging.

Paging examples
- Page 1:
  auralogger get-logs -maxcount 20
- Page 2:
  auralogger get-logs -maxcount 20 -nextpage 18423
- Page 3:
  auralogger get-logs -maxcount 20 -nextpage 16701

Fields and operators
- type: in, not-in (default in)
- message: contains, not-contains (default contains)
- location: in, not-in (default in)
- time: since, from-to (default since)
- order: eq
- maxcount: eq
- nextpage: eq
- data.<path>: eq

Examples
auralogger get-logs -type '["error","warn"]' -maxcount 50
auralogger get-logs -message '["timeout"]' -nextpage 18423 -maxcount 30
auralogger get-logs -type --not-in '["info","debug"]' -time --since '["10m"]'
auralogger get-logs -data.userId '["06431f39-55e2-4289-80c8-5d0340a8b66e"]'

Run commands from the directory containing .env / .env.local so process.cwd() resolves credentials.

CLI command reference

Short and bossy: what each subcommand does, how to spell get-logs filters, and copy-paste examples. For the full tour, see the docs below; for env spellings, see Getting values.

Overview

This page is only the command cheat sheet for quick lookup. The full getting started story is linked below.

The full getting started story (install, auralogger.com, environment variables, and code examples) is in Get started. Variable details: Getting values.

Generated: 2026-04-08 09:38:59 UTC

Invocation

1auralogger <command> [arguments...]

Commands

No flags except filter tokens on get-logs. Paging: each run performs one POST /api/{project_token}/logs and prints that response — no built-in multi-page loop. Use -maxcount (capped at 100 in the CLI) and -nextpage to continue from the cursor returned by the previous response.

Command	Args	Purpose
init	—	Banner, then prompts; `POST /api/{project_token}/proj_auth` (token in path); copy-paste dotenv up to five lines: `AURALOGGER_PROJECT_TOKEN`, `AURALOGGER_USER_SECRET`, `AURALOGGER_PROJECT_SESSION`, `NEXT_PUBLIC_AURALOGGER_PROJECT_TOKEN`, `VITE_AURALOGGER_PROJECT_TOKEN` (each omitted if already set); no id/styles keys. Two snippets (Auralog + AuraLog). See Getting values.
server-check	—	Test WebSocket connectivity (needs project id + `AURALOGGER_PROJECT_TOKEN` + `AURALOGGER_USER_SECRET` in env).
client-check	—	Same project/session context resolution as `server-check`; opens `/{proj_token}/create_browser_logs` with path-only auth (no headers).
test-serverlog	—	Send 5 logs via `AuraServer.log` (production path), then close.
test-clientlog	—	Send 5 logs via `AuraClient.log` (production path), then close.
get-logs	[filters…]	Fetch and print logs; filters use the grammar below. If `AURALOGGER_PROJECT_STYLES` (or public equivalents) is missing, runs the same `proj_auth` fetch as `init` and styles logs from the response (prompts for project token / user secret when needed).

Command examples

One block per command; toggle Node vs Python from the header.

1pip install auralogger

1auralogger init

1auralogger server-check

1auralogger client-check

1auralogger test-serverlog

1auralogger test-clientlog

Paging examples (one command = one page)

Pick a page size via -maxcount. Each run prints one page; use the nextpage cursor from the previous response to continue.

1# Page 1
2auralogger get-logs -maxcount 20
3 
4# Page 2 (use the `nextpage` number printed by page 1)
5auralogger get-logs -maxcount 20 -nextpage 18423
6 
7# Page 3 (use the `nextpage` number printed by page 2)
8auralogger get-logs -maxcount 20 -nextpage 16701
9 
10# Filtered paging: keep the same filters; only change -nextpage
11auralogger get-logs -type '["error","warn"]' -time --since '["30m"]' -maxcount 20
12auralogger get-logs -type '["error","warn"]' -time --since '["30m"]' -maxcount 20 -nextpage 18423

get-logs filter grammar

Looks like flags, tastes like JSON — maxcount / nextpage want numbers; almost everything else wants arrays.

1-<field> [--<operator>] <json-value>

maxcount, nextpage: value is a JSON number.
All other fields: value is a JSON array.

Fields

Field	Operators	Default op
type	in, not-in	in
message	contains, not-contains	contains
location	in, not-in	in
time	since, from-to	since
order	eq	eq
maxcount	eq	eq
nextpage	eq	eq
data.<path>	eq	eq

Examples

1auralogger get-logs -type '["error","warn"]' -maxcount 50
2auralogger get-logs -message '["timeout"]' -nextpage 18423 -maxcount 30
3auralogger get-logs -type --not-in '["info","debug"]' -time --since '["10m"]'
4auralogger get-logs -data.userId '["06431f39-55e2-4289-80c8-5d0340a8b66e"]'

Environment

Required variables and how to inject them.

Get env values from the project setup guide:

Go to Projects (/projects).
Click your project.
Click the Setup guide button.
Copy the env keys from the guide.

See Getting values on the Get started page for names, CLI flow, and how to load them in your repo.