Audream CLI

Local audio in. Structured JSON out.

Use the Node.js command-line client for local upload, deterministic polling, Notes, Insights, artifacts, and grounded workspace questions.

Read the documentation ↗View the CLI repository

Version 0.1.0

Requires Node.js 20 or newer and currently installs directly from the public GitHub repository.

Version0.1.0

Last reviewed2026-10-16

Full referencedocs.audream.ai ↗

WHAT THE PLATFORM COVERS

A complete product surface.

Script-friendly output

Results go to stdout as JSON while diagnostics stay on stderr.

Local file upload

Submit an audio file, retain the Note ID, and optionally wait for processing to finish.

Asynchronous safety

Polling keeps queued and processing states distinct from terminal success.

Confirmed deletion

Permanent Note or generated-result deletion requires an exact confirmation Note ID.

START WITH A REAL WORKFLOW

Make the first call.

Follow the published authentication boundary for this interface. Keep credentials out of browsers, mobile apps, firmware, logs, and source control.

npm install --global github:audream-ai/audream-cli
export AUDREAM_API_KEY="audream_sk_..."
audream auth status
audream notes list

IMPLEMENTATION BOUNDARIES

Know the environment before connecting.

Prerequisites

Node.js 20 or newer
An Audream account
A revocable API key stored outside source control

Authentication

Set AUDREAM_API_KEY only in a trusted shell or secret manager. Review any custom API base before a credential is sent.

Compatibility

macOS, Linux, and Windows environments supported by Node.js 20+
Shell and automation workflows that can consume JSON

Errors and asynchronous work

JSON is written to stdout and diagnostics to stderr. Non-terminal processing states remain incomplete until bounded polling reaches success or failure.

Deletion

Permanent deletion requires the exact --confirm NOTE_ID argument.

Complete reference

The detailed contract, current installation steps, scopes, and operation schemas remain in the versioned Audream documentation.

Open the complete documentation ↗

DELIVERY

What we can put in scope.

Install guide
Authentication setup
Command reference
Automation examples
Deletion safeguards

Published boundary

The current CLI is not an offline transcription engine and should not be described as an npm-registry release, credential vault, or streaming uploader.

KEEP EXPLORING

Choose the next useful detail.

View the CLI repository↗

A PRODUCT, NOT A PILE OF PARTS

Build against the published interface.

Open Audream Docs ↗