Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 3.4 KB

index.md

File metadata and controls

88 lines (67 loc) · 3.4 KB

Plaude — User Guide

Offline command-line tool for the Plaud Note voice recorder. Connects over Bluetooth — no cloud, no phone app needed after initial setup.

Quick Start

1. Install

make install    # installs `plaude` to ~/.cargo/bin

2. Set up your auth token

If you already have your token (32 hex characters):

plaude auth set-token <your-32-hex-token>

Or capture it automatically from the phone app (requires the Plaud app open on your phone):

plaude auth bootstrap

3. Use it

plaude battery                         # check battery (no token needed)
plaude device info                     # device name, storage stats
plaude files list                      # list recordings
plaude files pull-one <ID> -o ~/plaud  # download a recording
plaude record start                    # start recording remotely
plaude record stop                     # stop recording

Commands

Command What it does Auth required?
battery Show battery percentage No
device info Show device name, model, storage Yes
device privacy on/off Toggle privacy mode Yes
device name Show device name Yes
files list List recordings on device Yes
files pull-one Download a recording Yes
record start/stop/pause/resume Remote recording control Yes
settings list/get/set Read/write device settings Yes
sync Mirror all recordings to a directory Yes
auth set-token/show/clear/import Manage stored token No
auth bootstrap Capture token from phone app No
transcribe Transcribe WAV via whisper.cpp No
llm check Verify LLM provider connectivity No
summarize Summarize transcripts using LLM No
summaries list/show/delete Manage recording summaries No
correct Fix transcript errors using LLM No
template list/show/add/edit/delete Manage summarization templates No

Backends

Plaude supports multiple ways to connect to your device:

Flag Transport Use case
--backend ble (default) Bluetooth Low Energy Primary — wireless, all commands
--backend usb --mount /path USB Mass Storage Fallback — full WAV files, fast
--backend sim In-process simulator Testing and development

Exit Codes

Code Meaning What to do
0 Success —
1 Runtime error Check the error message
2 Bad usage Check plaude --help
69 Device unreachable Is the device on? Is Bluetooth enabled?
77 No auth token Run plaude auth bootstrap or plaude auth set-token
78 Token rejected Run plaude auth bootstrap to get a fresh token

Privacy Notice

Run plaude --about to see the full disclosure. Key points:

  1. BLE traffic is unencrypted — don't sync in hostile environments
  2. WAV files contain your device serial — use --sanitise with sync
  3. The auth token is a permanent credential — stored in your OS keyring