Reference2 min read

Advanced & source builds

Launch specific app windows, understand the local source layout and use the project’s development tools.

On this page

Launch flags#

The application recognizes these flags for opening a particular surface at startup. They are useful for local shortcuts and development; ordinary users can use the tray controls instead.

Flag	Purpose
`--settings`	Open Settings.
`--history`	Open History.
`--dictation-box`	Open the dictation box.
`--setup`	Open guided setup again.
`--overlay-demo`	Cycle status-bar states for visual development. This is a demonstration, not recognition.

Source builds#

The project uses the .NET 8 SDK for development on Windows. The installer only requires the Desktop Runtime; compiling from source requires the SDK.

Run from source

git clone https://github.com/JupitorStudioDev/TawkType.git
cd TawkType
dotnet run --project src/TawkType.App

The first-run checks and model requirements also apply to a source build. A build is not useful for dictation until the microphone works and a matching model is available.

TawkType is open source under Apache 2.0. See Licence & attribution for the licence, contribution terms and third-party notices.

Project layout#

Area	Responsibility
`src/TawkType.Core`	Settings, cleanup, vocabulary, history, setup rules and dictation coordination.
`src/TawkType.Windows`	Microphone, global input, focus checks, clipboard, injection and Windows integration.
`src/TawkType.Transcription`	Local engines, language routing and model storage.
`src/TawkType.Llm`	Optional Anthropic client.
`src/TawkType.App`	Desktop windows, view models, services and app startup.
`tests/TawkType.Core.Tests`	Tests of core rules and behavior.
`tools/`	Focused benchmark, cleanup, focus-probe and branding tools.

The architecture and working notes in the repository provide deeper implementation context. This public manual focuses on the behavior users need to understand.

Development commands#

Project tools

dotnet test
dotnet run --project tools/TawkType.Bench -- speech.wav Both 5
dotnet run --project tools/TawkType.Clean -- "um the deadline is monday no wait tuesday"
dotnet run --project tools/TawkType.Focus -- 15

The benchmark command requires an input audio file and the relevant models. Measurements depend on the machine, model, input and warm-up state; do not compare isolated timings as universal performance claims.

The focus probe helps inspect what Windows exposes for a destination. The cleanup tool helps isolate text transformations from recording and recognition. Tests of core rules do not replace hardware and real-application testing.

Development build versus installed release#

Automatic update staging applies to installed copies. A plain local build is updated by updating and rebuilding its source. Version information normally derives from release tags, with explicit build-version overrides available to the release process.

Do not use --overlay-demo to judge microphone or recognition behavior: it deliberately simulates visual states. Use guided setup or a real recording for end-to-end checks.