Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## 1.1.0 — v1.1.0 · The right microphone, one click away

- Add **Microphone** to the tray menu: **System default (name)** and every microphone, the one in use checked. A click makes it the microphone for the next recordings — the laptop's own while the headset for calls stays plugged in. It is the same setting as Settings → Recording → Microphone, saved at once, and the window follows.
- Read the microphones again as they come and go: at startup, when the window lists them, and on Windows and macOS when the pointer reaches the tray icon. A chosen microphone that is unplugged stays in the menu greyed out; recordings use the system default until it is back.
- On Linux the same submenu is served through Utterform's own StatusNotifierItem.
- The first stable release since 0.8.0: everything of 1.0.0-rc.1 (stages 0.9.0 to 0.14.0) ships with it. 1.0.0 was not released separately.
- App version 1.1.0; the installers install v1.1.0 by default.

See [1.1.0 release notes](docs/releases/v1.1.0.md).

## 1.0.0-rc.1 — v1.0.0-rc.1 · Say it, it's done (prerelease)

- First installed build of everything since 0.8.0: the stages 0.9.0 to 0.14.0 below — Settings with search and no Save button, text actions on the ChatGPT subscription, the Context action, an action per application, audio files and the first-run assistant.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Utterform records a short voice clip, transcribes it with **OpenAI GPT Transcrib
the cursor. The window can stay out of the way while a global shortcut controls the
whole flow.

> Utterform is under active development. **0.8.0 — Omarchy's dictation key** makes Utterform a dictation backend for Omarchy: choose it in Setup → Defaults → Dictation, then press Alt + Space or hold Right Alt. The Apple-Silicon build is Developer ID signed and notarized; Windows remains unsigned. See the [release notes](docs/releases/v0.8.0.md) and [downloads](https://github.com/jli-software/utterform/releases/tag/v0.8.0). **1.0.0 release candidate 1** brings everything since — first-run assistant, Settings with search, ChatGPT text actions, Context, an action per app and audio files — and waits for acceptance on all three platforms: [release notes](docs/releases/v1.0.0-rc.1.md), [downloads](https://github.com/jli-software/utterform/releases/tag/v1.0.0-rc.1).
> **1.1.0 — The right microphone, one click away** switches the microphone from the tray menu and brings everything since 0.8.0: a first-run assistant, Settings with search, ChatGPT text actions, Context, an action per app and audio files. The Apple-Silicon build is Developer ID signed and notarized; Windows remains unsigned. See the [release notes](docs/releases/v1.1.0.md) and [downloads](https://github.com/jli-software/utterform/releases/tag/v1.1.0).

## How it works

Expand Down Expand Up @@ -332,7 +332,7 @@ Push/PR CI runs Linux validation without release compilation. For a test binary
- An action per app for the dictation key: Email in the mail client, Plain in the terminal
- A vocabulary of your own terms, and a reasoning effort for the text step
- Clipboard, TXT, Markdown, or combined output
- Selectable microphone with a system-default fallback
- Selectable microphone with a system-default fallback, in Settings and in the tray menu
- Global dictation with a reserved key combination on Windows, macOS and X11, or a compositor binding on Wayland: either way without raising the window
- Optional typing of the finished text into the focused window, next to clipboard and file, as one paste or as keystrokes (Linux and Windows)
- A dictation key recorded by pressing it, read by physical key so the layout cannot change it
Expand Down
28 changes: 28 additions & 0 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,34 @@ Ghostty); macOS uses the localized name.
`recording.app_action` (action) when a rule takes over. The application is never logged:
which program someone dictates into says as much as a window title.

## Microphone in the tray (1.1.0)

**One setting, two places.** The tray's **Microphone** submenu writes
`settings.input_device`, the field Settings → Recording → Microphone writes; `None` is the
system default. `tray_microphones::choose` loads `settings.json`, changes only that field,
saves it, and then emits `microphone-chosen` with the id. The window copies it into its
settings without saving; a pending or later save already carries it. The backend saves
first so the choice holds even if no window ever loaded. A recording that is running
keeps its microphone; the choice applies to the next `start_recording`.

**The menu.** `tray_microphones::entries` turns the known devices and the choice into
lines: **System default (name of the default device)**, then every device, exactly one
checked. A chosen id that is not connected gets a greyed, checked line "Chosen microphone
(not connected, using system default)", because `audio::select_device` falls back to the
default then. Menu ids are `microphone:default` and `microphone:device:<cpal id>`.
Windows and macOS rebuild Tauri's native menu with `tray.set_menu` (labels escape `&`);
Linux updates the `SubMenu` of its own StatusNotifierItem through the ksni handle (labels
escape `_`).

**Staying current.** The devices are read at startup (off the event loop), whenever the
window calls `list_input_devices` (its copy is reused), and on Windows and macOS on
`TrayIconEvent::Enter`, at most every two seconds, so a microphone plugged in since shows
up before the menu opens. `save_settings` and `complete_onboarding` move the checkmark.
Linux has no such hover event; there the list follows the window.

**Diagnostics.** `tray.microphone_chosen` (`default` or `device`) and
`tray.microphones_failed` (step). Device names are not logged.

## First-run assistant (0.14.0)

**Who sees it.** `settings.onboarding_completed`. `AppSettings::default()` — what `load`
Expand Down
17 changes: 16 additions & 1 deletion docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,22 @@ proposals are in [plans/v1.0-roadmap.md](plans/v1.0-roadmap.md). The plan of 202
(reliability, assistant, finish) is superseded; 0.7.13 shipped, 0.7.14
(`feat/simple-settings`) was rejected and will not be merged.

## Current handoff — 1.0.0 Finish
## Current handoff — 1.1.0 Microphone in the tray

Branch `work/utterform-1.1.0-tray-microphone`. Jonas asked on 2026-11-13 for a quick
microphone switch in the tray (headset plugged in for calls, but dictating into the
laptop's microphone), Windows first, then macOS and Linux, released directly as 1.1.0
without a release candidate; nobody else uses Utterform yet. He chose "release 1.1.0
straight away" over first releasing 1.0.0: 1.1.0 is the first stable release since
0.8.0 and contains all of 1.0.0-rc.1. Design in
[ARCHITECTURE.md → Microphone in the tray](ARCHITECTURE.md#microphone-in-the-tray-110).
CBZIT007 (Windows) has no Visual C++ Build Tools; Rust was compiled and tested by the
`Desktop builds` workflow, the frontend locally. Open after the release: a real check of
the tray submenu on each desktop, the open points of
[plans/v1.0-acceptance.md](plans/v1.0-acceptance.md), and a new WinGet submission
(PR #27 is the last one, at 0.7.11).

## Previous handoff — 1.0.0 Finish

Stage 1.0.0 of [the roadmap](plans/v1.0-roadmap.md), branch `work/utterform-1.0.0-finish`.
Jonas decided on 2026-11-08 to accept a real signed prerelease: the app is 1.0.0, the
Expand Down
3 changes: 2 additions & 1 deletion docs/plans/v1.0-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ Proposals not yet confirmed by Jonas are marked **Proposal**.
| 0.12.0 | Action per application | merged, ships with 1.0 |
| 0.13.0 | Audio files | merged, ships with 1.0 |
| 0.14.0 | First-run assistant | merged, ships with 1.0 |
| 1.0.0 | Acceptance on Linux, Windows, macOS; release; WinGet | in progress: rc.1 out for acceptance |
| 1.0.0 | Acceptance on Linux, Windows, macOS; release; WinGet | rc.1 published; not released on its own — ships as 1.1.0 |
| 1.1.0 | Microphone in the tray; first stable release since 0.8.0 | released (2026-11-13) |

**Proposal (order):** the Omarchy backend first because it is small and the CLI already
exists; Settings next so every later feature gets a fixed place; Codex before context
Expand Down
37 changes: 37 additions & 0 deletions docs/releases/v1.1.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Utterform 1.1.0 — The right microphone, one click away

*The first stable release since 0.8.0. It brings everything of the 1.0.0 release
candidate and adds the microphone to the tray menu. There is no separate 1.0.0.*

**Switch the microphone from the tray.** The headset for calls is plugged in, but you
want to talk to the laptop. Right-click the Utterform icon, open **Microphone** and pick
the laptop's microphone. The next dictation uses it, and it stays chosen until you pick
another one. **System default** follows the microphone your system uses and names it, so
you see at a glance which one that is. It is the same setting as Settings → Recording →
Microphone; both always agree.

Plugging a microphone in or out is noticed: on Windows and macOS the list is read again
as the pointer reaches the tray icon, and everywhere when the window opens. A chosen
microphone that is unplugged stays in the menu, greyed out, and recordings fall back to
the system default until it is back.

**Everything from 1.0.** A first-run assistant, Settings with search and no Save button,
text actions on your ChatGPT subscription (experimental), the Context action for the
selected text or the clipboard, an action per application and transcription of voice
messages and audio files. The details are in the
[1.0.0 release candidate notes](v1.0.0-rc.1.md) and in the changelog under 0.9.0 to
0.14.0.

## Install

Quit Utterform first.

- **Linux (Omarchy / Arch):**
`curl -fsSL https://github.com/jli-software/utterform/releases/download/v1.1.0/install-linux.sh | sh`
- **Windows (PowerShell):**
`irm https://github.com/jli-software/utterform/releases/download/v1.1.0/install-windows.ps1 | iex`
- **macOS:** the [DMG](https://github.com/jli-software/utterform/releases/download/v1.1.0/utterform-macos-aarch64.dmg),
Developer ID signed and notarized.

Windows builds remain unsigned and may trigger SmartScreen. Verify downloads against
`SHA256SUMS.txt`.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "utterform",
"private": true,
"version": "1.0.0",
"version": "1.1.0",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

set -eu

version="${UTTERFORM_VERSION:-v1.0.0-rc.1}"
version="${UTTERFORM_VERSION:-v1.1.0}"
release_base="${UTTERFORM_RELEASE_BASE_URL:-https://github.com/jli-software/utterform/releases/download/${version}}"
asset="utterform-linux-x86_64-system.tar.gz"
prefix="${UTTERFORM_PREFIX:-${HOME}/.local}"
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-windows.ps1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Verify the NSIS setup before opening it; no elevation or forced app shutdown.
param(
[string]$Version = 'v1.0.0-rc.1',
[string]$Version = 'v1.1.0',
[switch]$VerifyOnly
)

Expand Down
2 changes: 1 addition & 1 deletion src-tauri/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "utterform"
version = "1.0.0"
version = "1.1.0"
description = "Fast, lightweight voice-to-text transformation for the desktop"
authors = ["Jonas"]
edition = "2024"
Expand Down
11 changes: 8 additions & 3 deletions src-tauri/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ pub fn save_settings(app: AppHandle, value: AppSettings) -> Result<(), String> {
Ok(()) => {
app.state::<crate::Onboarding>()
.set(!value.onboarding_completed);
crate::tray_microphones::set_selected(&app, value.input_device.clone());
diagnostics::info!(
"settings.saved",
engine = value.engine.as_str(),
Expand Down Expand Up @@ -150,6 +151,7 @@ pub fn complete_onboarding(
));
}
app.state::<crate::Onboarding>().set(false);
crate::tray_microphones::set_selected(&app, value.input_device.clone());
if skipped {
diagnostics::info!("onboarding.skipped");
} else {
Expand All @@ -168,9 +170,12 @@ pub fn complete_onboarding(
}

#[tauri::command]
pub fn list_input_devices() -> Result<Vec<AudioDeviceInfo>, String> {
audio::list_input_devices()
.map_err(|failure| diagnostics::failure!("audio.devices_failed", &failure))
pub fn list_input_devices(app: AppHandle) -> Result<Vec<AudioDeviceInfo>, String> {
let devices = audio::list_input_devices()
.map_err(|failure| diagnostics::failure!("audio.devices_failed", &failure))?;
// The window has just looked; the tray's Microphone menu shows the same.
crate::tray_microphones::set_devices(&app, devices.clone());
Ok(devices)
}

/// Open the microphone and play the start cue.
Expand Down
3 changes: 3 additions & 0 deletions src-tauri/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ mod secrets;
mod settings;
mod transcription;
mod tray;
mod tray_microphones;
mod typing;

use tauri::Manager;
Expand Down Expand Up @@ -269,6 +270,7 @@ fn setup(app: &mut tauri::App, startup_intent: Intent) -> Result<(), Box<dyn std
}
}
tray::install(app.handle()).map_err(setup_stage("tray"))?;
tray_microphones::init(app.handle());
Ok(())
}

Expand Down Expand Up @@ -316,6 +318,7 @@ pub fn run() {
.manage(commands::FileBusy::default())
.manage(feedback::DoneCues::default())
.manage(tray::TrayState::default())
.manage(tray_microphones::MicrophoneMenu::default())
.manage(live::LiveState::default())
.manage(StartupIntent::default())
.manage(Onboarding::default())
Expand Down
Loading
Loading