Settings & System Commands

Assistant Configuration

get_assistant_info

Retrieves current assistant configuration and installed components.

const info = await invoke<AssistantInfoResponse>('get_assistant_info');

Response:

appVersion

string

Current application version

baseUrl

string

Default API base URL

sttModel

string

Default STT model name

aiModel

string

Default AI model name

piperInstalled

boolean

Whether Piper TTS is installed

piperPath

string

Path to Piper executable

voiceInstalled

boolean

Whether TTS voice model is installed

voiceModelPath

string

Path to voice model file

voiceConfigPath

string

Path to voice config file

coquiInstalled

boolean

Whether Coqui TTS is installed

coquiPythonPath

string

Path to Coqui Python environment

Runtime Setup

setup_assistant_runtime

Sets up the TTS runtime environment (Piper + voice model).

const setup = await invoke<RuntimeSetupResponse>('setup_assistant_runtime', {
  piperPath: '/custom/path/to/piper'  // Optional
});

piperPath

string

Custom Piper executable path (auto-detected if omitted)

Response:

piperPath

string

Installed Piper executable path

voiceModelPath

string

Installed voice model path

voiceConfigPath

string

Installed voice config path

validate_piper

Validates that Piper TTS is correctly configured.

const validation = await invoke<PiperValidationResponse>('validate_piper', {
  piperPath: '/path/to/piper'  // Optional
});

piperPath

string

Piper path to validate (uses default if omitted)

Response:

boolean

Whether validation passed

details

string

Validation result details

validate_coqui

Validates that Coqui TTS is correctly configured.

const validation = await invoke<CoquiValidationResponse>('validate_coqui', {
  pythonPath: '/path/to/python'  // Optional
});

pythonPath

string

Python environment path to validate

Response:

boolean

Whether validation passed

details

string

Validation result details

App Updates

check_for_app_update

Checks for available application updates from GitHub releases.

const update = await invoke<AppUpdateCheckResponse>('check_for_app_update');

Response:

currentVersion

string

Currently installed version

latestVersion

string

Latest available version

available

boolean

Whether an update is available

releaseName

string

Release title

releaseNotes

string

Markdown-formatted release notes

publishedAt

string

Release publication date (ISO 8601)

releaseUrl

string

GitHub release page URL

installerDownloadUrl

string

Direct download URL for installer

installerAssetName

string

Installer filename

install_app_update

Downloads and installs an application update.

await invoke('download_and_install_app_update', {
  downloadUrl: 'https://github.com/.../installer.exe',
  assetName: 'SlasshyWispr_1.2.0_setup.exe',  // Optional
  silent: true  // Optional
});

downloadUrl

string

required

Installer download URL (must be from trusted source)

assetName

string

Installer filename

silent

boolean

default:"true"

Run installer in silent mode

This command is currently Windows-only. The app will automatically exit after launching the installer.

System Integration

configure_launch_at_login

Enables or disables app launch at system startup.

await invoke('configure_launch_at_login', {
  enabled: true
});

enabled

boolean

required

Whether to launch at login

Currently Windows-only. Adds/removes registry entry in HKCU\Software\Microsoft\Windows\CurrentVersion\Run.

Examples

Check Status
Setup Runtime
Update App
Configure Startup

// Get complete assistant status
const info = await invoke<AssistantInfoResponse>('get_assistant_info');

console.log('App version:', info.appVersion);
console.log('Piper installed:', info.piperInstalled);
console.log('Coqui installed:', info.coquiInstalled);
console.log('Voice ready:', info.voiceInstalled);

// Setup Piper TTS runtime
const runtime = await invoke<RuntimeSetupResponse>('setup_assistant_runtime', {});

console.log('Piper path:', runtime.piperPath);
console.log('Voice model:', runtime.voiceModelPath);

// Validate setup
const validation = await invoke<PiperValidationResponse>('validate_piper', {});
if (!validation.ok) {
  console.error('Validation failed:', validation.details);
}

// Check for updates
const update = await invoke<AppUpdateCheckResponse>('check_for_app_update');

if (update.available) {
  console.log(`Update available: ${update.latestVersion}`);
  console.log('Release notes:', update.releaseNotes);
  
  // Install update
  await invoke('download_and_install_app_update', {
    downloadUrl: update.installerDownloadUrl,
    assetName: update.installerAssetName,
    silent: true
  });
}

// Enable launch at login
await invoke('configure_launch_at_login', {
  enabled: true
});

console.log('App will now launch at startup');

Platform Support

Some commands have platform-specific implementations:

Command	Windows	macOS	Linux
`get_assistant_info`	✅	✅	✅
`setup_assistant_runtime`	✅	✅	✅
`validate_piper`	✅	✅	✅
`validate_coqui`	✅	✅	✅
`check_for_app_update`	✅	✅	✅
`download_and_install_app_update`	✅	❌	❌
`configure_launch_at_login`	✅	❌	❌

Platform-specific commands will return an error on unsupported platforms indicating the limitation.

Architecture

Commands

Types

Settings & System Commands

Assistant Configuration

get_assistant_info

Runtime Setup

setup_assistant_runtime

validate_piper

validate_coqui

App Updates

check_for_app_update

install_app_update

System Integration

configure_launch_at_login

Examples

Platform Support

Build docs developers (and LLMs) love

Architecture

Commands

Types

​Assistant Configuration

​get_assistant_info

​Runtime Setup

​setup_assistant_runtime

​validate_piper

​validate_coqui

​App Updates

​check_for_app_update

​install_app_update

​System Integration

​configure_launch_at_login

​Examples

​Platform Support

Build docs developers (and LLMs) love

Assistant Configuration

get_assistant_info

Runtime Setup

setup_assistant_runtime

validate_piper

validate_coqui

App Updates

check_for_app_update

install_app_update

System Integration

configure_launch_at_login

Examples

Platform Support