feat: initial release v0.1.0
- Custom Keyboard Extension with push-to-talk UI - iOS 26 SpeechAnalyzer + DictationTranscriber (iOS 18 SF fallback) - OpenAI-compatible LLM client (4 built-in providers + custom) - 3-page onboarding flow + provider config UI - App Group shared storage for cross-process config - 8s LLM timeout with raw-transcript fallback - App Store privacy manifests for both targets - SwiftLint + XcodeGen + GitHub Actions CI - Unit tests (4/4 passing)
This commit is contained in:
@@ -0,0 +1,153 @@
|
||||
# OSGKeyboard
|
||||
|
||||
> Hold a key, speak, release — AI-polished text appears at your cursor in any app.
|
||||
> An open-source, custom-keyboard-based voice input tool for iOS 18+, inspired by [Typeless](https://typeless.com) and [OpenLess](https://github.com/Open-Less/openless).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[中文 README](./README.zh.md)
|
||||
|
||||
---
|
||||
|
||||
## What is it?
|
||||
|
||||
OSGKeyboard is a free, open alternative to commercial voice-input tools. It runs as a **Custom Keyboard Extension** on iOS, so you can use it in **any app** — Messages, Notes, Mail, ChatGPT, Claude, Cursor, you name it.
|
||||
|
||||
1. Press and hold the mic key
|
||||
2. Speak naturally
|
||||
3. Release — the AI polishes your words into clean text and inserts it at the cursor
|
||||
|
||||
The audio stays on-device (transcribed by Apple's on-device `SpeechAnalyzer` on iOS 26+, or `SFSpeechRecognizer` on iOS 18/19). Only the **polished transcript** is sent to your chosen cloud LLM. **No audio ever leaves your phone.**
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- 🎙 **Push-to-talk** with a Typeless-style circular mic button
|
||||
- 🧠 **On-device ASR** (iOS 26 `SpeechAnalyzer` + `DictationTranscriber`; iOS 18 `SFSpeechRecognizer` fallback)
|
||||
- ✍️ **AI polishing** — adds structure, punctuation, fixes grammar, optionally produces lists
|
||||
- 🔌 **Bring-your-own API** — works with any OpenAI-compatible endpoint (OpenAI, DeepSeek, Qwen DashScope, your own self-hosted server, …)
|
||||
- 🔒 **Privacy first** — audio never leaves your device; transcripts only sent to the LLM you choose
|
||||
- 🎨 **Native SwiftUI** — dark theme, frosted glass, ~2000 lines of Swift
|
||||
- 🪶 **Zero dependencies** — no SwiftPM packages, no CocoaPods, no Carthage
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
### Requirements
|
||||
|
||||
- macOS with **Xcode 16+** (Xcode 26 recommended)
|
||||
- iPhone running **iOS 18.0+** (iOS 26+ for the best on-device ASR)
|
||||
- [XcodeGen](https://github.com/yonaskolb/XcodeGen): `brew install xcodegen`
|
||||
- An OpenAI-compatible API key (e.g. from [OpenAI](https://platform.openai.com/api-keys), [DeepSeek](https://platform.deepseek.com/api_keys), or [Qwen DashScope](https://dashscope.console.aliyun.com/apiKey))
|
||||
|
||||
### Build & run
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<OWNER>/OSGKeyboard.git
|
||||
cd OSGKeyboard
|
||||
xcodegen generate # produces OSGKeyboard.xcodeproj
|
||||
open OSGKeyboard.xcodeproj # or build via CLI:
|
||||
xcodebuild -project OSGKeyboard.xcodeproj -scheme OSGKeyboard \
|
||||
-destination 'generic/platform=iOS Simulator' build
|
||||
```
|
||||
|
||||
### Enable the keyboard in iOS
|
||||
|
||||
1. Run the app on your device or simulator.
|
||||
2. Follow the 3-step onboarding: **enable the keyboard** in iOS Settings, then **allow Full Access** (required for the mic and LLM calls), then **paste your API key**.
|
||||
3. In any text field, tap 🌐 to switch to **OSGKeyboard**.
|
||||
4. Press and hold the mic, speak, release. ✨
|
||||
|
||||
> **"Allow Full Access" is required.** Without it, iOS blocks the keyboard from using the microphone and from making network requests. We never log, store, or transmit your keystrokes — see [`PrivacyInfo.xcprivacy`](./OpenLess/PrivacyInfo.xcprivacy).
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
OSGKeyboard/
|
||||
├── OpenLess/ # Main iOS app (settings, onboarding)
|
||||
│ ├── Views/ # SwiftUI screens
|
||||
│ ├── OSGKeyboardApp.swift # @main entry
|
||||
│ ├── PrivacyInfo.xcprivacy # Required privacy manifest
|
||||
│ └── OpenLess.entitlements # App Group declaration
|
||||
├── OpenLessKeyboard/ # Custom Keyboard Extension
|
||||
│ ├── KeyboardViewController.swift # Principal class
|
||||
│ ├── Services/
|
||||
│ │ ├── AudioCaptureService.swift # AVAudioEngine → 16 kHz PCM
|
||||
│ │ ├── ASRService.swift # iOS 26 + iOS 18 ASR
|
||||
│ │ └── PolishingService.swift # LLM call with timeout
|
||||
│ └── Views/ # RecordButton, Waveform, KeyboardRootView
|
||||
├── OpenLessShared/ # Framework shared by app + extension
|
||||
│ ├── Models/ # ProviderConfig, LLMRequest, LLMProvider
|
||||
│ ├── Services/ # LLMClient (OpenAI-compatible)
|
||||
│ └── Constants/ # AppGroup identifier
|
||||
├── OpenLessTests/ # XCTest unit tests
|
||||
├── project.yml # XcodeGen project definition
|
||||
└── .github/workflows/ci.yml # Lint + build CI
|
||||
```
|
||||
|
||||
### Data flow
|
||||
|
||||
```
|
||||
[Long-press mic] → AudioCaptureService → AudioBufferSnapshot (16 kHz mono)
|
||||
↓
|
||||
ASRService.transcribe()
|
||||
↓
|
||||
ASREvent.final(rawTranscript)
|
||||
↓
|
||||
PolishingService.polish()
|
||||
↓
|
||||
LLMClient (OpenAI-compatible)
|
||||
↓
|
||||
textDocumentProxy.insertText(polished)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Adding a new LLM provider
|
||||
|
||||
Open `OpenLessShared/Models/LLMProvider.swift` and append a new `LLMProvider` to the `presets` array. The default `OpenAICompatibleClient` handles any endpoint that speaks the `POST /chat/completions` protocol.
|
||||
|
||||
```swift
|
||||
LLMProvider(
|
||||
id: "groq",
|
||||
name: "Groq",
|
||||
defaultBaseURL: "https://api.groq.com/openai/v1",
|
||||
defaultModel: "llama-3.1-70b-versatile",
|
||||
apiKeyURL: URL(string: "https://console.groq.com/keys")
|
||||
)
|
||||
```
|
||||
|
||||
That's it. No other code changes required.
|
||||
|
||||
---
|
||||
|
||||
## Limitations
|
||||
|
||||
- iOS sandboxes keyboard extensions: ~60 MB memory cap, Full Access required.
|
||||
- The keyboard does **not** work in password fields or some `WKWebView` textareas (iOS limitation).
|
||||
- iOS 18 uses `SFSpeechRecognizer` instead of `SpeechAnalyzer`; on iOS 26, `SpeechAnalyzer` is significantly faster and supports more locales.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE) — use it, fork it, ship it. No warranty.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- Inspired by [Typeless](https://typeless.com) and the desktop open-source [OpenLess](https://github.com/Open-Less/openless)
|
||||
- Built with [XcodeGen](https://github.com/yonaskolb/XcodeGen)
|
||||
- Powered by Apple's [SpeechAnalyzer](https://developer.apple.com/documentation/speech/speechanalyzer) and [SFSpeechRecognizer](https://developer.apple.com/documentation/speech/sfspeechrecognizer)
|
||||
|
||||
---
|
||||
|
||||
**Note:** replace `<OWNER>` in badges and the git clone URL with your GitHub username.
|
||||
Reference in New Issue
Block a user