Documentation¶

How to build and run voice commands with Amri. Amri is configured through TOML profiles and the amri command-line tool today. A desktop app with a visual editor is planned; see The desktop app.

Commands¶

Pair what you say or press with the action Amri runs.

Page	What it does
Triggers	What fires a command: a spoken phrase, an input, or both.
Captures	Pull a spoken value out of a phrase for the command to act on.
Free-text and dictation	Capture open speech with `{name...}`, and the push-to-talk rule around it.
Push-to-talk	Gate listening behind a held key, at the profile, category, or command level.
Synonyms	Give a captured value extra spoken aliases.
Branching	Run a different response for each value you say.
Value maps	Remap a captured value before it is used.
Common errors	The profile-loading errors you may hit, and how to fix each.

Scripting¶

Add Lua logic when a command needs more than a single action.

Page	What it does
Functions	Call an `amri.*` function as a command response.
Variables and scopes	Store and read values, and the scope chain they follow.
The command context	Read what was said, and details of the current command, through `ctx`.
Speech and prompts	Speak to the user and ask for a spoken answer.
Tasks	Background loops, and how to stop them.
API reference	Every `amri.*` function, grouped by namespace.

Profiles¶

Group commands per game, switch between them, and set what a profile may do.

Page	What it does
Composition	How a profile is assembled from includes, overlays, and libraries.
User overlays and overrides	Change a profile you did not write, in a way that survives its updates.
Auto-switch	Activate a profile when a game takes focus.
Profile settings	Identity, defaults, and per-profile audio.
Declared outputs	The keys a profile is allowed to press, and the silent-drop gotcha.
Trust	What a profile is allowed to do, and how Amri decides.
Grants and the sandbox	What a script can do by default, and the grants that widen it.
System overrides	The built-in commands, and overriding them.

Running Amri¶

Configure and tune the engine through engine.toml and the amri command-line tool.

Page	What it does
Setup and permissions	First run: the one permission step and the check-up.
Audio and microphone	Choose which microphone Amri listens to.
Listening modes	Always listening, or gated behind a held key.
Recognition and dictation	Fixed commands and free dictation, and the models each needs.
Tuning recognition	The sensitivity and latency knobs.
Diagnostics	`amri doctor`, the debug bag, and log levels.
Compatibility	Which desktops and games Amri can detect.

The desktop app¶

Planned. Today Amri is configured through the TOML profiles and CLI above.

Page	What it does
The desktop app	What the planned desktop app will be.
The command editor	The planned command editor, and the rungs it offers.
Controller Mode	The planned controller-first mode.