From 3a2d7e73ede52b134ba61234f83594d5b10df779 Mon Sep 17 00:00:00 2001
From: LwkMoon <300192895+LwkMoon@users.noreply.github.com>
Date: Tue, 17 Nov 2026 18:11:32 +0500
Subject: [PATCH] Prepare Microsoft Store release
---
.github/workflows/build.yml | 57 ++-
.github/workflows/store-package.yml | 56 +++
CHANGELOG.md | 25 ++
Directory.Build.props | 2 +-
README.md | 122 ++++--
SECURITY.md | 9 +-
THIRD-PARTY-NOTICES.md | 46 ++
assets/banner.svg | 2 +-
config.example.json | 7 +-
docs/ARCHITECTURE.md | 90 ++++
docs/PRIVACY.md | 104 +++++
docs/RELEASE-CHECKLIST.md | 40 ++
docs/commands.md | 100 ++---
docs/store/LISTING.md | 167 ++++++++
docs/store/PACKAGING.md | 127 ++++++
docs/store/STORE-READINESS.md | 122 ++++++
packaging/AppxManifest.xml | 64 +++
.../Assets/Square150x150Logo.scale-100.png | Bin 0 -> 5972 bytes
.../Assets/Square150x150Logo.scale-125.png | Bin 0 -> 7441 bytes
.../Assets/Square150x150Logo.scale-150.png | Bin 0 -> 8718 bytes
.../Assets/Square150x150Logo.scale-200.png | Bin 0 -> 11765 bytes
.../Assets/Square150x150Logo.scale-400.png | Bin 0 -> 23394 bytes
.../Assets/Square44x44Logo.scale-100.png | Bin 0 -> 2042 bytes
.../Assets/Square44x44Logo.scale-125.png | Bin 0 -> 2646 bytes
.../Assets/Square44x44Logo.scale-150.png | Bin 0 -> 3066 bytes
.../Assets/Square44x44Logo.scale-200.png | Bin 0 -> 4046 bytes
.../Assets/Square44x44Logo.scale-400.png | Bin 0 -> 8233 bytes
.../Assets/Square44x44Logo.targetsize-16.png | Bin 0 -> 685 bytes
.../Assets/Square44x44Logo.targetsize-24.png | Bin 0 -> 1082 bytes
.../Assets/Square44x44Logo.targetsize-256.png | Bin 0 -> 12102 bytes
.../Assets/Square44x44Logo.targetsize-32.png | Bin 0 -> 1501 bytes
.../Assets/Square44x44Logo.targetsize-48.png | Bin 0 -> 2267 bytes
packaging/Assets/StoreLogo.scale-100.png | Bin 0 -> 2313 bytes
packaging/Assets/StoreLogo.scale-125.png | Bin 0 -> 2902 bytes
packaging/Assets/StoreLogo.scale-150.png | Bin 0 -> 3503 bytes
packaging/Assets/StoreLogo.scale-200.png | Bin 0 -> 4620 bytes
packaging/Assets/StoreLogo.scale-400.png | Bin 0 -> 9288 bytes
.../Assets/Wide310x150Logo.scale-100.png | Bin 0 -> 5674 bytes
.../Assets/Wide310x150Logo.scale-125.png | Bin 0 -> 7242 bytes
.../Assets/Wide310x150Logo.scale-150.png | Bin 0 -> 8747 bytes
.../Assets/Wide310x150Logo.scale-200.png | Bin 0 -> 11551 bytes
.../Assets/Wide310x150Logo.scale-400.png | Bin 0 -> 25409 bytes
.../StoreListingIcon-300x300.png | Bin 0 -> 13775 bytes
packaging/tools/make_assets.py | 108 +++++
scripts/Install-DevMsix.ps1 | 18 +
scripts/New-MsixPackage.ps1 | 128 ++++++
src/FlowCommand.Core/Ai/IAiProvider.cs | 4 +-
src/FlowCommand.Core/Ai/LocalRuleProvider.cs | 397 ++++++++++++++++++
src/FlowCommand.Core/Ai/PromptBuilder.cs | 6 +-
src/FlowCommand.Core/Ai/ProviderCatalog.cs | 11 +-
src/FlowCommand.Core/Config/AppConfig.cs | 11 +-
src/FlowCommand.Core/Config/ConfigStore.cs | 1 +
.../Pipeline/CommandPipeline.cs | 5 +-
src/FlowCommand/App.xaml.cs | 90 +++-
src/FlowCommand/Assets/FlowCommand.ico | Bin 0 -> 29521 bytes
src/FlowCommand/FlowCommand.csproj | 6 +
src/FlowCommand/Platform/AppLinks.cs | 11 +
src/FlowCommand/Platform/AppPaths.cs | 25 +-
src/FlowCommand/Platform/PackageIdentity.cs | 35 ++
.../Platform/StartupRegistration.cs | 63 ++-
src/FlowCommand/Platform/WisprFlowDetector.cs | 31 ++
src/FlowCommand/ServiceHost.cs | 26 ++
src/FlowCommand/UI/PaletteWindow.xaml.cs | 2 +-
src/FlowCommand/UI/SettingsWindow.xaml | 65 ++-
src/FlowCommand/UI/SettingsWindow.xaml.cs | 85 +++-
src/FlowCommand/UI/TrayService.cs | 49 ++-
src/FlowCommand/UI/WelcomeWindow.xaml | 60 +++
src/FlowCommand/UI/WelcomeWindow.xaml.cs | 108 +++++
src/FlowCommand/app.manifest | 7 +
tests/FlowCommand.Tests/ConfigAndUtilTests.cs | 8 +-
.../FlowCommand.Tests/GeminiProviderTests.cs | 7 +-
.../LocalRuleProviderTests.cs | 224 ++++++++++
.../PackagingAndPolicyTests.cs | 190 +++++++++
.../FlowCommand.Tests/ReleaseContentTests.cs | 2 +-
tests/FlowCommand.Tests/ToolSchemaTests.cs | 6 +-
75 files changed, 2745 insertions(+), 184 deletions(-)
create mode 100644 .github/workflows/store-package.yml
create mode 100644 THIRD-PARTY-NOTICES.md
create mode 100644 docs/ARCHITECTURE.md
create mode 100644 docs/PRIVACY.md
create mode 100644 docs/RELEASE-CHECKLIST.md
create mode 100644 docs/store/LISTING.md
create mode 100644 docs/store/PACKAGING.md
create mode 100644 docs/store/STORE-READINESS.md
create mode 100644 packaging/AppxManifest.xml
create mode 100644 packaging/Assets/Square150x150Logo.scale-100.png
create mode 100644 packaging/Assets/Square150x150Logo.scale-125.png
create mode 100644 packaging/Assets/Square150x150Logo.scale-150.png
create mode 100644 packaging/Assets/Square150x150Logo.scale-200.png
create mode 100644 packaging/Assets/Square150x150Logo.scale-400.png
create mode 100644 packaging/Assets/Square44x44Logo.scale-100.png
create mode 100644 packaging/Assets/Square44x44Logo.scale-125.png
create mode 100644 packaging/Assets/Square44x44Logo.scale-150.png
create mode 100644 packaging/Assets/Square44x44Logo.scale-200.png
create mode 100644 packaging/Assets/Square44x44Logo.scale-400.png
create mode 100644 packaging/Assets/Square44x44Logo.targetsize-16.png
create mode 100644 packaging/Assets/Square44x44Logo.targetsize-24.png
create mode 100644 packaging/Assets/Square44x44Logo.targetsize-256.png
create mode 100644 packaging/Assets/Square44x44Logo.targetsize-32.png
create mode 100644 packaging/Assets/Square44x44Logo.targetsize-48.png
create mode 100644 packaging/Assets/StoreLogo.scale-100.png
create mode 100644 packaging/Assets/StoreLogo.scale-125.png
create mode 100644 packaging/Assets/StoreLogo.scale-150.png
create mode 100644 packaging/Assets/StoreLogo.scale-200.png
create mode 100644 packaging/Assets/StoreLogo.scale-400.png
create mode 100644 packaging/Assets/Wide310x150Logo.scale-100.png
create mode 100644 packaging/Assets/Wide310x150Logo.scale-125.png
create mode 100644 packaging/Assets/Wide310x150Logo.scale-150.png
create mode 100644 packaging/Assets/Wide310x150Logo.scale-200.png
create mode 100644 packaging/Assets/Wide310x150Logo.scale-400.png
create mode 100644 packaging/store-listing/StoreListingIcon-300x300.png
create mode 100644 packaging/tools/make_assets.py
create mode 100644 scripts/Install-DevMsix.ps1
create mode 100644 scripts/New-MsixPackage.ps1
create mode 100644 src/FlowCommand.Core/Ai/LocalRuleProvider.cs
create mode 100644 src/FlowCommand/Assets/FlowCommand.ico
create mode 100644 src/FlowCommand/Platform/AppLinks.cs
create mode 100644 src/FlowCommand/Platform/PackageIdentity.cs
create mode 100644 src/FlowCommand/Platform/WisprFlowDetector.cs
create mode 100644 src/FlowCommand/UI/WelcomeWindow.xaml
create mode 100644 src/FlowCommand/UI/WelcomeWindow.xaml.cs
create mode 100644 tests/FlowCommand.Tests/LocalRuleProviderTests.cs
create mode 100644 tests/FlowCommand.Tests/PackagingAndPolicyTests.cs
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 2f8ad6a..70c8045 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -25,4 +25,59 @@ jobs:
run: dotnet build FlowCommand.slnx -c Release --no-restore
- name: Test
- run: dotnet test tests/FlowCommand.Tests/FlowCommand.Tests.csproj -c Release --no-build --verbosity normal
+ run: dotnet test tests/FlowCommand.Tests/FlowCommand.Tests.csproj -c Release --no-build --verbosity normal --logger "trx;LogFileName=results.trx" --results-directory TestResults
+
+ - name: Dependency audit (known vulnerabilities fail the build)
+ shell: pwsh
+ run: |
+ $failed = $false
+ foreach ($proj in "src/FlowCommand/FlowCommand.csproj", "src/FlowCommand.Core/FlowCommand.Core.csproj", "tests/FlowCommand.Tests/FlowCommand.Tests.csproj") {
+ $v = dotnet list $proj package --vulnerable --include-transitive 2>&1 | Out-String
+ Write-Host $v
+ if ($v -match "has the following vulnerable packages") { $failed = $true }
+ $d = dotnet list $proj package --deprecated 2>&1 | Out-String
+ Write-Host $d
+ }
+ if ($failed) { throw "Vulnerable NuGet packages found. See the log above." }
+
+ - uses: actions/upload-artifact@v4
+ if: always()
+ with:
+ name: test-results
+ path: TestResults
+
+ msix:
+ needs: build-and-test
+ runs-on: windows-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: actions/setup-dotnet@v4
+ with:
+ dotnet-version: 10.0.x
+
+ - name: Build development MSIX (self-signed, for sideload testing only)
+ shell: pwsh
+ run: ./scripts/New-MsixPackage.ps1 -Target dev
+
+ - name: Verify package contents
+ shell: pwsh
+ run: |
+ $msix = Get-ChildItem artifacts/msix -Filter *.msix | Select-Object -First 1
+ $tool = Get-ChildItem "${env:ProgramFiles(x86)}\Windows Kits\10\bin\*\x64\makeappx.exe" |
+ Sort-Object FullName -Descending | Select-Object -First 1
+ & $tool.FullName unpack /p $msix.FullName /d artifacts/unpacked /o
+ if ($LASTEXITCODE -ne 0) { throw "makeappx unpack failed" }
+ foreach ($f in "FlowCommand.exe", "AppxManifest.xml", "resources.pri", "coreclr.dll", "Assets/StoreLogo.scale-200.png") {
+ if (-not (Test-Path "artifacts/unpacked/$f")) { throw "Missing from package: $f" }
+ }
+ if (Select-String -Path artifacts/unpacked/AppxManifest.xml -Pattern '\{\{') { throw "Unfilled token left in AppxManifest.xml" }
+ Write-Host "Package layout verified: $($msix.Name)"
+
+ - uses: actions/upload-artifact@v4
+ with:
+ name: flowcommand-msix-dev
+ path: |
+ artifacts/msix/*.msix
+ artifacts/msix/*.cer
+ artifacts/msix/SHA256SUMS.txt
diff --git a/.github/workflows/store-package.yml b/.github/workflows/store-package.yml
new file mode 100644
index 0000000..33fb30f
--- /dev/null
+++ b/.github/workflows/store-package.yml
@@ -0,0 +1,56 @@
+name: store-package
+
+# Builds the UNSIGNED MSIX to upload to Microsoft Partner Center. Run it by hand from the Actions tab
+# after reserving the app name, and paste the three values from Partner Center > Product identity.
+# Nothing is published or uploaded by this workflow: it only produces a downloadable build artifact.
+
+on:
+ workflow_dispatch:
+ inputs:
+ identity_name:
+ description: "Package/Identity/Name from Partner Center"
+ required: true
+ publisher:
+ description: "Package/Identity/Publisher from Partner Center (starts with CN=)"
+ required: true
+ publisher_display_name:
+ description: "Package/Properties/PublisherDisplayName from Partner Center"
+ required: true
+ version:
+ description: "Three-part version, for example 1.0.1 (must be higher than every version already submitted)"
+ required: false
+
+permissions:
+ contents: read
+
+jobs:
+ package:
+ runs-on: windows-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: actions/setup-dotnet@v4
+ with:
+ dotnet-version: 10.0.x
+
+ - name: Test
+ run: dotnet test tests/FlowCommand.Tests/FlowCommand.Tests.csproj -c Release
+
+ - name: Build Store MSIX
+ shell: pwsh
+ env:
+ IDENTITY_NAME: ${{ inputs.identity_name }}
+ PUBLISHER: ${{ inputs.publisher }}
+ PUBLISHER_DISPLAY_NAME: ${{ inputs.publisher_display_name }}
+ VERSION: ${{ inputs.version }}
+ run: |
+ $params = @{ Target = "store"; IdentityName = $env:IDENTITY_NAME; Publisher = $env:PUBLISHER; PublisherDisplayName = $env:PUBLISHER_DISPLAY_NAME }
+ if ($env:VERSION) { $params.Version = $env:VERSION }
+ ./scripts/New-MsixPackage.ps1 @params
+
+ - uses: actions/upload-artifact@v4
+ with:
+ name: flowcommand-msix-store
+ path: |
+ artifacts/msix/*.msix
+ artifacts/msix/SHA256SUMS.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b618c01..87bb0a6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,31 @@ All notable changes to this project are documented here. The format follows
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
[Semantic Versioning](https://semver.org/).
+## [Unreleased]
+
+Preparation for a Microsoft Store release.
+
+### Added
+- **Offline mode** (`provider: "local"`): a rule-based interpreter for common commands. It needs no account or key and sends nothing
+ anywhere. New installs start in this mode; online Gemini or Claude remains available with your own key.
+- Welcome screen on first run: what FlowCommand does, offline or online, trigger choice, optional start with Windows.
+- Tray: **Pause listening for the trigger** (removes the keyboard hook and hotkey), **Privacy policy**, **Report a problem or get support**.
+- Settings: About, privacy and data section with **Delete all my FlowCommand data**, log folder, data location.
+- MSIX packaging (`packaging/`, `scripts/New-MsixPackage.ps1`, `scripts/Install-DevMsix.ps1`) and CI jobs that build and check it.
+- Application icon, tile assets and Store logo from one generated design.
+- Documentation: privacy policy and data inventory, Store readiness audit, packaging guide, listing draft, test plan, architecture,
+ release checklist, third-party notices.
+- Tests for the offline interpreter, first-run migration, package manifest, privacy policy and listing limits.
+
+### Changed
+- Wispr Flow is described as an optional companion, not a requirement. It was never integrated; any tool that types text works.
+- Default provider for new installs is offline. Existing `config.json` files keep their provider (config version 3 only adds `firstRunCompleted`).
+- A second launch now brings the running copy's Settings window forward instead of showing an error.
+- Microsoft Store installs keep settings, keys and logs in the package's own folder and use a Windows startup task instead of the Run key.
+- Per-monitor DPI awareness; accessibility names on the main Settings controls.
+- Dependency audit (`dotnet list package --vulnerable`) added to CI.
+- Documentation no longer uses em-dashes.
+
## [1.0.0]
First public release.
diff --git a/Directory.Build.props b/Directory.Build.props
index 52522c4..5b5f49c 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -8,7 +8,7 @@
LwkMoonFlowCommandCopyright (c) 2026 LwkMoon
- Voice-controlled Windows command palette: turns the text Wispr Flow dictates into validated, locally executed Windows actions.
+ Command palette for Windows: turns a short spoken or typed command into one validated, locally executed action. Works offline; online AI is optional.https://github.com/LwkMoon/FlowCommand
diff --git a/README.md b/README.md
index a4ccc31..477cec1 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-
+
### Speak naturally. Let Windows do the rest.
-FlowCommand turns **Wispr Flow's text output** into structured, AI-interpreted commands for Windows — without building another speech-recognition engine or keeping a microphone open.
+FlowCommand turns a short spoken or typed command into one validated action on your PC. It works **offline out of the box**, pairs well with dictation tools such as Wispr Flow, and can optionally use your own Gemini or Claude key for free-form wording. No speech engine, no microphone access, no telemetry.
@@ -18,6 +18,8 @@ FlowCommand turns **Wispr Flow's text output** into structured, AI-interpreted c
Downloads
·
+ Install
+ ·
Quick start
·
Commands
@@ -35,20 +37,27 @@ FlowCommand turns **Wispr Flow's text output** into structured, AI-interpreted c
## What is FlowCommand?
-**Wispr Flow is the input. FlowCommand is the action layer.**
+**Your dictation or keyboard is the input. FlowCommand is the action layer.**
+
+A dictation tool such as Wispr Flow already does the difficult part: turning speech into clean text. FlowCommand takes that text (or anything you type), works out the intended Windows action, validates the result locally, and runs only an action that is explicitly supported by the application.
+
+There is no speech-recognition engine, no microphone capture inside FlowCommand, and no always-listening voice assistant. A small command palette receives the text that your dictation tool inserts into it.
-Wispr Flow already does the difficult part: turning speech into clean text. FlowCommand takes that text, asks an AI provider to identify the intended Windows action, validates the response locally, and runs only an action that is explicitly supported by the application.
+Commands are understood in one of two ways, chosen on the first-run welcome screen and changeable in Settings:
-There is no second speech-recognition engine, no microphone capture inside FlowCommand, and no always-listening voice assistant. A small command palette receives the text that Wispr Flow inserts into it.
+| Mode | What it needs | What leaves your PC |
+|---|---|---|
+| **Offline** (default) | Nothing | Nothing |
+| **Online AI** (Gemini or Claude) | Your own API key | The text of each command, sent to the provider you chose |
### The idea
1. Open the FlowCommand palette by double-tapping the **backtick** key (the one to the left of **1**).
-2. Use the normal Wispr Flow hotkey and speak naturally.
-3. Wispr Flow inserts the transcript into the palette.
-4. Gemini or Claude maps the text to one structured action.
+2. Speak with your dictation tool (for example the usual Wispr Flow hotkey), or just type.
+3. The text appears in the palette.
+4. FlowCommand maps the text to one structured action: offline rules by default, or Gemini or Claude if you chose online AI.
5. FlowCommand validates the action, checks its local risk policy, and runs it when allowed.
For example:
@@ -66,20 +75,23 @@ For example:
| “Search for the best pizza near me” | Run a web search in your browser |
| “Take a screenshot” | Save a full-screen screenshot |
-> **Wispr Flow is required.** FlowCommand is an independent companion application, not a replacement for Wispr Flow and not an official Wispr product or integration.
+> **Wispr Flow is optional.** FlowCommand does not talk to Wispr Flow or depend on it. It works with any tool that types text, including your keyboard. FlowCommand is an independent project, not a replacement for Wispr Flow and not an official Wispr product or integration.
+
+Offline mode understands the common phrasings in the table above and in the [command reference](docs/commands.md) (open, close, switch, volume, screenshots and so on). Free-form requests such as "get me to my invoices from last month" need online AI.
## Why FlowCommand?
Most voice-control tools bring their own speech engine, microphone handling, command interface, and setup. FlowCommand takes a smaller approach: use the dictation tool already installed and add a local, configurable action layer on top.
-- **Use the dictation you already trust.** Wispr Flow handles speech recognition and transcript cleanup.
+- **Use the dictation you already trust.** Tools such as Wispr Flow handle speech recognition and transcript cleanup.
- **No microphone capture in FlowCommand.** The application receives text, not audio.
-- **Bring your own AI key.** Choose Google Gemini or Anthropic Claude and enter your own API key.
+- **Works with no account.** Offline mode needs no key and sends nothing anywhere.
+- **Optional online AI.** Choose Google Gemini or Anthropic Claude and enter your own API key for free-form wording.
- **Local action execution.** Windows actions are handled by the desktop application, not by a remote automation service.
- **Ready on day one.** 65 applications, 69 websites, 14 folders, and 36 Settings pages are built in. See the [command reference](docs/commands.md).
- **Configurable.** Add application aliases, websites, project folders, and named folders without changing code.
- **Safety checks stay local.** The model cannot invent a PowerShell command or bypass the action allowlist.
-- **No telemetry.** FlowCommand has no analytics and no update check. Its only network traffic is the request to the AI provider you choose.
+- **No telemetry.** FlowCommand has no analytics and no update check. Its only network traffic is the request to the AI provider you choose, and only if you choose one.
## What it can do
@@ -157,20 +169,20 @@ The current command model intentionally maps one dictated request to one action.
## Requirements
-- **Windows 10 version 1809 or newer** (Windows 11 is supported).
-- **[Wispr Flow for Windows](https://wisprflow.ai/)** installed, configured, and working with its normal dictation hotkey.
-- An API key for at least one supported provider:
- - [Google AI Studio](https://aistudio.google.com/) for Gemini.
- - [Anthropic Console](https://console.anthropic.com/) for Claude.
-- **For the downloadable build:** nothing extra if you choose the *self-contained* archive. The smaller archive needs the [.NET 10 Windows Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/10.0).
+- **Windows 10 version 1809 or newer** (Windows 11 is supported). See [docs/TESTING.md](docs/TESTING.md) for the versions that have actually been tested.
+- **Optional:** a dictation tool such as [Wispr Flow](https://wisprflow.ai/) or Windows voice typing, if you want to speak commands. Typing works without one.
+- **Optional:** an API key for online AI. [Google AI Studio](https://aistudio.google.com/) for Gemini, or the [Anthropic Console](https://console.anthropic.com/) for Claude.
- **For building from source:** the .NET 10 SDK.
-Each release offers two Windows x64 archives:
+## Install
-| Archive | When to choose it |
+| Route | Notes |
|---|---|
-| `FlowCommand--win-x64-self-contained.zip` | **Recommended for most people.** Larger, but runs on a PC with nothing else installed. |
-| `FlowCommand--win-x64.zip` | Smaller. Needs the .NET 10 Desktop Runtime installed. |
+| **Microsoft Store** | Planned. Signed by Microsoft, updates automatically, removes cleanly. Not published yet; see [docs/store/STORE-READINESS.md](docs/store/STORE-READINESS.md). |
+| **GitHub release (zip)** | `FlowCommand--win-x64-self-contained.zip` runs on a PC with nothing else installed (recommended). `FlowCommand--win-x64.zip` is smaller but needs the [.NET 10 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/10.0). Not code-signed, so SmartScreen may warn. |
+| **From source** | See [Development](#development). |
+
+To uninstall the Store version use Windows Settings, Apps, Installed apps. To remove the zip version, exit FlowCommand from the tray, delete its folder, and delete `%APPDATA%\FlowCommand` and `%LOCALAPPDATA%\FlowCommand`. Either way, **Settings, Delete all my FlowCommand data** removes your saved keys and settings first if you prefer.
## Quick start
@@ -180,18 +192,18 @@ Each release offers two Windows x64 archives:
2. Download an archive (see [Requirements](#requirements)) and extract it to a folder you control.
3. Optional: verify the download. Each release includes `SHA256SUMS.txt`; compare it with the result of `Get-FileHash .\.zip -Algorithm SHA256` in PowerShell.
4. Run `FlowCommand.exe`.
-5. FlowCommand appears in the Windows system tray. On first launch, Settings opens so an AI provider can be configured.
+5. FlowCommand appears in the Windows system tray and shows a welcome screen that explains how it works and lets you choose offline or online understanding, the trigger, and whether to start with Windows (off by default).
FlowCommand is not code-signed, so Windows SmartScreen may show a warning the first time. Select **More info → Run anyway** if you trust the download source. If there is no release attached yet, build the application from source using the instructions in [Development](#development).
-### 2. Add an AI provider key
+### 2. Optional: add an AI provider key
-In Settings:
+Skip this to stay offline. To understand free-form wording, open Settings and:
-1. Select **Gemini** or **Anthropic**.
+1. Select **Google Gemini** or **Anthropic Claude**.
2. Check or edit the model ID.
3. Paste your API key.
-4. Select **Test AI (runs nothing)**.
+4. Select **Test (runs nothing)**.
5. Save the settings.
The test asks the provider to interpret a harmless sample request; it does not execute a Windows action.
@@ -214,14 +226,14 @@ Once the result is what you expect, turn Dry-run mode off.
### 4. Open the palette and dictate
-The default trigger is **double-tapping the backtick key** — the key to the left of **1**, printed `` ` `` and `~`.
+The default trigger is **double-tapping the backtick key** - the key to the left of **1**, printed `` ` `` and `~`.
1. Click the desktop or another area that does not have a text field focused.
2. Double-tap the backtick key.
3. Wait for the FlowCommand palette to appear and focus its input.
-4. Hold the usual Wispr Flow dictation hotkey.
-5. Say a command, such as “Open Chrome”.
-6. Release the Wispr Flow hotkey. The transcript is inserted into FlowCommand.
+4. Use your dictation hotkey (for example Wispr Flow's), or just start typing.
+5. Say or type a command, such as “Open Chrome”.
+6. If dictating, release the hotkey. The transcript is inserted into FlowCommand.
7. In the default `paste` mode, FlowCommand submits the inserted text after a short quiet period. Press Enter to submit immediately instead.
The palette stays open after an action so another command can be dictated. Press Escape to cancel a pending confirmation, clear the current input, or close the palette. Double-tap the trigger key again to close it too.
@@ -389,8 +401,9 @@ Your existing `config.json` keeps working. Actions that are new in a release are
| Setting | Purpose |
|---|---|
-| `provider` | `gemini` or `anthropic` |
-| `model` | Model ID sent to the selected provider |
+| `provider` | `local` (offline, default), `gemini` or `anthropic` |
+| `model` | Model ID sent to the selected online provider (ignored offline) |
+| `firstRunCompleted` | `false` shows the welcome screen again |
| `geminiThinkingLevel` | Gemini thinking hint: `minimal`, `low`, `medium`, `high`, or empty for the model default. Use only values supported by the selected model. |
| `requestTimeoutSeconds` | AI request timeout, normalised to 5–60 seconds (default 30) |
| `doubleTapEnabled` | Enables or disables the double-tap trigger |
@@ -466,13 +479,13 @@ FlowCommand uses **your own API key**. Keys entered in Settings are encrypted us
When a command is interpreted, the selected AI provider receives text needed to understand the request. Depending on the settings and the configured commands, that includes:
-- The dictated transcript.
+- The dictated or typed command text.
- The available action names and descriptions.
- Configured application names, aliases, categories, and default-app mappings.
- Configured project names and aliases, folder names, and website names.
- A short history of recent commands and their results when `useConversationContext` is enabled. Up to four turns are held in memory, expire after ten minutes, and are cleared when FlowCommand exits.
-**Audio is not sent by FlowCommand.** FlowCommand does not capture or process the microphone. It receives the text inserted by Wispr Flow. Configured executable paths, project and folder locations, and website addresses are not included in the prompt.
+**Audio is not sent by FlowCommand.** FlowCommand does not capture or process the microphone. It receives text typed or inserted by your dictation tool. In offline mode none of this is sent anywhere. Configured executable paths, project and folder locations, and website addresses are not included in the prompt.
Action logs are stored locally in:
@@ -480,6 +493,8 @@ Action logs are stored locally in:
%LOCALAPPDATA%\FlowCommand\logs
```
+The Microsoft Store version keeps settings, keys and logs inside the app's own package folder instead (Settings shows the exact path), and Windows removes them when the app is uninstalled. The full data inventory and privacy policy are in [docs/PRIVACY.md](docs/PRIVACY.md).
+
Transcript logging is off by default. When `logTranscripts` is enabled, dictated text is included in the local log. Review logs before sharing them in a public issue.
The AI provider processes requests under its own terms, privacy policy, pricing, and usage limits. Review the current policies for the selected provider before using it with sensitive information. FlowCommand does not provide an API key or cover provider charges.
@@ -500,7 +515,8 @@ The double-tap uses a Windows low-level keyboard hook, described in [Hotkeys and
## Limitations
-- **Wispr Flow is a dependency.** FlowCommand is designed for people who already use it. It does not include a speech engine.
+- **No speech engine.** To speak commands, use a dictation tool such as Wispr Flow or Windows voice typing (the latter is untested). Typing always works.
+- **Offline mode is rule-based.** It handles common English phrasings only. Use online AI for free-form wording or other languages.
- **Focus detection is best-effort.** Some browsers, Electron apps, custom-drawn text fields, games, and remote sessions may not expose their focused input control reliably. Use `openWhenFocusUnknown: false` for stricter handling or use the optional shortcut.
- **The double-tap is intentionally gated.** When a text field is detected, it does not open the palette. The optional registered shortcut bypasses this gate.
- **Store/UWP app support is limited.** Apps with Start Menu shortcuts may launch, but closing or managing their windows is not generally supported without a resolvable process name.
@@ -532,7 +548,7 @@ The double-tap uses a Windows low-level keyboard hook, described in [Hotkeys and
Wispr Flow text does not appear in the palette
- Make sure the FlowCommand palette is visible and its input has focus before dictating.
-- Confirm that Wispr Flow is working in another ordinary text field.
+- Confirm that your dictation tool is working in another ordinary text field.
- Run both applications at the same Windows privilege level. If Wispr Flow is elevated, Windows may prevent it from inserting text into a non-elevated FlowCommand window.
- Try pressing Enter after the transcript appears.
@@ -565,7 +581,7 @@ The double-tap uses a Windows low-level keyboard hook, described in [Hotkeys and
- Verify the API key in the provider's console.
- Confirm that the model ID is available to the account and API endpoint.
- Check provider usage limits, account billing, and network access.
-- Use **Test AI (runs nothing)** in Settings to test the connection without executing a Windows action.
+- Use **Test (runs nothing)** in Settings to test the connection without executing a Windows action.
@@ -596,7 +612,7 @@ That is expected for media keys and for opening websites or searches: FlowComman
Windows SmartScreen or antivirus warns about FlowCommand
-FlowCommand is not code-signed, so SmartScreen may warn about a new download. Compare the archive's SHA-256 with `SHA256SUMS.txt` from the release. The double-tap trigger uses a low-level keyboard hook, which some security products flag; see the [keyboard listener note](#keyboard-listener-note) and review `DoubleTapKeyListener.cs`. You can turn the trigger off and use the optional hotkey instead.
+The zip build is not code-signed, so SmartScreen may warn about a new download (the Microsoft Store version is signed by Microsoft). Compare the archive's SHA-256 with `SHA256SUMS.txt` from the release. The double-tap trigger uses a low-level keyboard hook, which some security products flag; see the [keyboard listener note](#keyboard-listener-note) and review `DoubleTapKeyListener.cs`. You can turn the trigger off and use the optional hotkey instead.
@@ -651,6 +667,15 @@ To launch from source with the Dry-run helper:
The helper changes an existing `dryRun: false` setting to `true` before launching. On a first run, create the configuration file by launching FlowCommand once, then use the helper and verify the **DRY RUN** indicator is visible in the palette.
+### Microsoft Store package (MSIX)
+
+```powershell
+.\scripts\New-MsixPackage.ps1 # development build, self-signed, for testing on your own PC
+.\scripts\Install-DevMsix.ps1 # installs it (administrator PowerShell)
+```
+
+The Store build needs the identity values from Partner Center and produces an unsigned package that Microsoft signs. Everything about it, including what is verified and what is not, is in [docs/store/PACKAGING.md](docs/store/PACKAGING.md).
+
### Releases
`scripts/package-release.ps1 -Version v1.0.0` builds both release archives and `SHA256SUMS.txt` into `artifacts/`. Pushing a tag that starts with `v` runs the `release` workflow, which runs the tests, builds those archives, and creates a **draft** GitHub release for you to review and publish. The `build` workflow builds and tests every push and pull request.
@@ -665,10 +690,18 @@ FlowCommand/
├── tests/
│ └── FlowCommand.Tests/ # xUnit tests
├── docs/
-│ └── commands.md # Full command reference
+│ ├── commands.md # Full command reference
+│ ├── ARCHITECTURE.md # How the pieces fit together
+│ ├── PRIVACY.md # Privacy policy and data inventory
+│ ├── TESTING.md # Manual test plan and recorded results
+│ ├── RELEASE-CHECKLIST.md
+│ └── store/ # Microsoft Store readiness, packaging and listing drafts
+├── packaging/ # MSIX manifest template, tile assets, asset generator
├── scripts/
│ ├── build-and-test.ps1 # Restore, build, test, and publish
│ ├── package-release.ps1 # Build the release archives and checksums
+│ ├── New-MsixPackage.ps1 # Build the MSIX package
+│ ├── Install-DevMsix.ps1 # Install the development MSIX for testing
│ └── run-dry.ps1 # Run from source with Dry-run enabled
├── assets/ # README media
├── .github/ # CI and release workflows, issue and pull request templates
@@ -678,6 +711,7 @@ FlowCommand/
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
├── SECURITY.md
+├── THIRD-PARTY-NOTICES.md
├── LICENSE
└── README.md
```
@@ -694,11 +728,11 @@ The prompt and tool schema are generated from the action catalogue, and the Sett
### Add an AI provider
-Implement `IAiProvider`, add the provider's structured tool-call request/response handling, and register its name and default model in the provider catalogue/factory. Provider output must pass through the same local validation and risk policy as every other provider.
+Implement `IAiProvider`, add the provider's structured tool-call request/response handling, and register its name and default model in the provider catalogue/factory. Provider output must pass through the same local validation and risk policy as every other provider. The offline interpreter (`LocalRuleProvider`) is itself a provider and a good small example.
## Ideas for later
-These are possibilities, not promises: setting an exact volume level, more AI providers (including local models), multi-step routines, a signed installer or `winget` package, and more languages. Issues and pull requests are welcome.
+These are possibilities, not promises: setting an exact volume level, more AI providers (including local models), multi-step routines, a `winget` package, and more languages. Issues and pull requests are welcome.
## Contributing
@@ -716,8 +750,8 @@ FlowCommand is released under the [MIT License](LICENSE). You are free to use, c
## Acknowledgements
-- [Wispr Flow](https://wisprflow.ai/) provides the speech-to-text input used by this companion application.
-- [Google Gemini](https://ai.google.dev/) and [Anthropic Claude](https://www.anthropic.com/) provide the optional AI interpretation APIs.
+- [Wispr Flow](https://wisprflow.ai/) is one of the dictation tools FlowCommand can be used with. It is a separate product by another company.
+- [Google Gemini](https://ai.google.dev/) and [Anthropic Claude](https://www.anthropic.com/) provide the optional online AI interpretation APIs.
- Built with C#, .NET 10, WPF, Windows APIs, and xUnit.
FlowCommand is an independent community project. It is not affiliated with, sponsored by, or endorsed by Wispr or the AI providers listed above. All product names, logos, and trademarks mentioned are the property of their respective owners and are used only to identify the software FlowCommand works with.
diff --git a/SECURITY.md b/SECURITY.md
index 8b4b8d4..e73b536 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -20,6 +20,7 @@ Examples of in-scope problems:
- A way to make FlowCommand run something outside its action catalogue (for example through crafted AI output, a crafted
dictated phrase, or a crafted `config.json` field that should have been rejected).
- Bypassing validation, the enabled-action allowlist, risk levels or required confirmations.
+- Anything in the offline interpreter or the welcome and settings screens that lets text become an action outside the catalogue.
- Exposure of API keys (in logs, the config file, network requests to anyone but the chosen provider, or on disk unencrypted).
- The key listener recording, storing or transmitting anything other than "was this the trigger key".
- Closing or terminating protected system processes.
@@ -33,4 +34,10 @@ of the AI providers themselves, and findings in third-party software.
- There is no shell, script, arbitrary-file or registry action.
- URLs and file paths come from configuration, never from the AI.
- API keys are encrypted with Windows DPAPI for the current user and are not written to logs or `config.json`.
-- The only network traffic is the request to the AI provider you configured.
+- The only network traffic is the request to the AI provider you configured, and only when you choose an online provider.
+ The default offline mode sends nothing. A test keeps the privacy policy in step with the addresses in the code.
+- The keyboard listener checks one key and cancels on others. It can be paused from the tray (no hook or hotkey is registered while paused).
+- Microsoft Store builds run as a normal user (full-trust desktop app, no administrator rights) with no microphone or camera capability.
+ Windows signs the Store package; zip builds are not signed.
+- The offline interpreter produces the same structured plan as an AI would, and that plan goes through the same strict validation and
+ risk policy, so it cannot run anything outside the catalogue either.
diff --git a/THIRD-PARTY-NOTICES.md b/THIRD-PARTY-NOTICES.md
new file mode 100644
index 0000000..3b784de
--- /dev/null
+++ b/THIRD-PARTY-NOTICES.md
@@ -0,0 +1,46 @@
+# Third-party notices
+
+FlowCommand's own code is released under the [MIT License](LICENSE).
+
+## What ships inside the application
+
+| Component | Used for | License | Notes |
+|---|---|---|---|
+| .NET 10 runtime and libraries (Microsoft) | Runs the app. Included in the self-contained zip and in the Store package | MIT | |
+| Windows Presentation Foundation and Windows Forms (Microsoft) | Windows, and the tray icon | MIT | , |
+| Windows SDK .NET projections for WinRT APIs (`Windows.Devices.Radios`, `Windows.Storage`, `Windows.ApplicationModel`) | Bluetooth control, package-aware data folder, startup task | Part of the .NET Windows target framework (`net10.0-windows10.0.17763.0`) | Not a separate NuGet package in this repo |
+
+FlowCommand's two production projects contain **no NuGet package references**, so there are no other bundled libraries. Tests
+(`PackagingAndPolicyTests`, `NoMicrophoneCodeTests`) fail if a package reference is added to either production project, which is the prompt to update this file.
+
+When a Store or self-contained build is produced, the .NET runtime files are copied into the package. Their license text is in the
+`LICENSE.txt` and `THIRD-PARTY-NOTICES.TXT` files that the .NET publish step places beside the executable.
+
+## Used only to build and test (not shipped)
+
+| Component | License |
+|---|---|
+| xUnit (`xunit`, `xunit.runner.visualstudio`) | Apache-2.0 |
+| Microsoft.NET.Test.Sdk | MIT |
+| Windows 10/11 SDK tools (`makeappx`, `makepri`, `signtool`) | Microsoft SDK license; used by the packaging script, not redistributed |
+| Pillow (Python), `packaging/tools/make_assets.py` | HPND (MIT-CMU style) |
+
+## Services FlowCommand can talk to (optional, user-initiated)
+
+These are not bundled code. They are online services that the person chooses to use with their own account.
+
+| Service | When | Terms |
+|---|---|---|
+| Google Gemini API | Only if the person selects it and supplies their own key | |
+| Anthropic API | Only if the person selects it and supplies their own key | |
+
+## Names and logos
+
+Wispr, Wispr Flow, Google, Gemini, Anthropic, Claude, Microsoft and Windows are trademarks of their respective owners. They are
+named in plain text only, to say what FlowCommand works with. No third-party logo is used. FlowCommand is not affiliated with,
+sponsored by or endorsed by any of them.
+
+## Keeping this file correct
+
+Re-check versions and licenses before each release: run `dotnet list package --include-transitive` on each project and compare with the
+tables above. The release checklist includes this step.
diff --git a/assets/banner.svg b/assets/banner.svg
index 9b54f2d..887a9eb 100644
--- a/assets/banner.svg
+++ b/assets/banner.svg
@@ -1,5 +1,5 @@