### Deep Link Examples for Superwhisper Mode Switching

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/modes/switching-modes.mdx

These deep links can be used to switch between Superwhisper modes or initiate recording. The `superwhisper://mode?key=YOUR_MODE_KEY` link allows switching to a specific mode identified by its key, while `superwhisper://record` starts the recording function. Mode keys can be found in the JSON files within the `~/Documents/superwhisper/modes` directory.

```shell
superwhisper://mode?key=YOUR_MODE_KEY
superwhisper://record
```

--------------------------------

### Cron Job Schedule Examples (Cron Syntax)

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/history-management.mdx

Examples of cron syntax for scheduling tasks. These examples demonstrate how to run a job every hour, every 30 minutes, or once a week. The syntax specifies the minute, hour, day of the month, month, and day of the week.

```cron
0 * * * * ...
```

```cron
*/30 * * * * ...
```

```cron
0 0 * * 0 ...
```

--------------------------------

### Switch Mode and Start Recording via Deep Links (Bash)

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

These commands demonstrate how to programmatically switch to a specific Superwhisper mode and initiate recording using deep links. Mode keys can be found in the Superwhisper modes JSON file. This is useful for creating custom automation workflows.

```bash
# Switch to a specific mode
open "superwhisper://mode?key=YOUR_MODE_KEY"

# Start recording
open "superwhisper://record"

# Open settings
open "superwhisper://settings"

# Find your mode key at:
# ~/Documents/superwhisper/modes/[mode-name].json
# Look for the "key" value in the JSON file

# Combine mode switch and record in shell script:
#!/bin/bash
open "superwhisper://mode?key=email-mode"
sleep 0.5
open "superwhisper://record"
```

--------------------------------

### Open Settings via Deep Link

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/settings.mdx

This method uses a deep link to programmatically open Superwhisper's settings panel. It's useful for automation and integration with other applications. No specific dependencies are required beyond the Superwhisper application being installed.

```text
superwhisper://settings
```

--------------------------------

### Transcribe Audio File via Command Line (Bash)

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/transcribe-files.mdx

This command-line snippet demonstrates how to initiate a file transcription using Superwhisper via the Bash shell. It requires the path to the audio file and the Superwhisper application. Ensure Superwhisper is installed and accessible in your system's applications.

```bash
open /path/to/your/audiofile.mp3 -a superwhisper
```

--------------------------------

### Custom Mode AI Instructions (XML)

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

This XML snippet illustrates how to define AI instructions for a custom mode in Superwhisper. It includes role, instructions, requirements, and examples of using content references like 'User Message', 'Application Context', 'Selected Text', and 'Clipboard Context'.

```xml
<!-- Example Custom Mode AI Instructions -->
<role>You are a text editor</role>
<instructions>Format the content of User Message into clear paragraphs</instructions>

<requirements>
- Use simple, clear language
- Keep the casual tone
- Break into short paragraphs
</requirements>

<!-- Available content references in prompts: -->
<!-- User Message - Your dictated text -->
<!-- Application Context - Data from active application window -->
<!-- Selected Text - Text selected when triggering dictation -->
<!-- Clipboard Context - Text you've copied -->

<!-- Example instruction using references: -->
"If Application Context shows a code editor:
- Format the User Message as code comments
- Use coding style from Clipboard Context as reference"
```

--------------------------------

### Plant Store Endpoints

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/api-reference/introduction.mdx

This section provides details on the Plant Store API endpoints. The OpenAPI specification for these endpoints can be found at the provided GitHub link.

```APIDOC
## Plant Store Endpoints

### Description

This endpoint group relates to the Plant Store functionality. Refer to the OpenAPI specification for detailed endpoint information.

### Method

GET, POST, PUT, DELETE (Varies by specific endpoint)

### Endpoint

/api/plants (Example base endpoint, specific paths will vary)

### Parameters

#### Path Parameters

(Details depend on the specific endpoint in the OpenAPI specification)

#### Query Parameters

(Details depend on the specific endpoint in the OpenAPI specification)

#### Request Body

(Details depend on the specific endpoint in the OpenAPI specification)

### Request Example

(Example request body will vary based on the specific endpoint)

### Response

#### Success Response (200)

(Details depend on the specific endpoint in the OpenAPI specification)

#### Response Example

(Example response body will vary based on the specific endpoint)
```

--------------------------------

### Accessing Superwhisper Settings

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

Provides multiple methods for accessing the Superwhisper application settings. These include using the menu bar, keyboard shortcuts, context menus on the recording window, and a deep link for programmatic access.

```bash
# Method 1: Menu Bar
# Click Superwhisper icon > Settings

# Method 2: Keyboard Shortcut (with dock icon visible)
# Click dock icon, then press Cmd + ,

# Method 3: Recording Window
# Right-click on mini recording window > Open Settings

# Method 4: Deep Link
open "superwhisper://settings"
```

--------------------------------

### AI Language Models for Processing (Cloud)

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

Lists available cloud-based AI language models from providers like Anthropic (Claude) and OpenAI (GPT), along with Groq for ultra-fast inference. It includes model names, speed, benchmark scores, and license types, aiding in the selection of appropriate AI models for text processing tasks.

```markdown
# Anthropic Claude Models (Cloud)
| Model             | Speed | Benchmark | License |
|-------------------|-------|-----------|---------|
| Claude 4.5 Sonnet | 8     | 89        | Pro     |
| Claude 4 Sonnet   | 8     | 87        | Pro     |
| Claude 3.7 Sonnet | 8     | 85        | Pro     |
| Claude 3.5 Haiku  | 9     | 75        | Pro     |

# OpenAI GPT Models (Cloud)
| Model        | Speed | Benchmark | License |
|--------------|-------|-----------|---------|
| GPT-5        | 7     | 91        | Pro     |
| GPT-5 mini   | 8     | 87        | Pro     |
| GPT-4.1      | 7     | 90        | Pro     |
| GPT-4.1 mini | 8     | 86        | Pro     |

# Groq (Ultra-fast inference)
| Model      | Speed | Benchmark | License |
|------------|-------|-----------|---------|
| Llama 3 8b | 10    | 67        | Pro     |
```

--------------------------------

### Manual iOS App Activation Link Generation (Troubleshooting)

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/activate-ios.mdx

This manual method allows users to generate an activation URL for the Superwhisper iOS app if QR code scanning fails. It involves copying the license key and constructing the activation link manually.

```text
superwhisper://license/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
```

--------------------------------

### Auto-Activation Rules Configuration (JSON)

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

Illustrates the JSON format for configuring auto-activation rules in Superwhisper. These rules allow the application to automatically switch modes based on the currently active applications or websites, enhancing workflow efficiency.

```json
// Example: Mode JSON configuration
{
  "key": "email-mode",
  "name": "Email Mode",
  "autoActivation": {
    "apps": ["Mail", "Outlook", "Gmail"],
    "websites": ["mail.google.com", "outlook.live.com"]
  }
}
```

--------------------------------

### iOS App Activation via URL (Windows)

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/activate-ios.mdx

For Windows users, the iOS app can be activated by manually entering a license key via a URL in Safari. This method bypasses the need for a QR code scanner present on the Mac version.

```text
superwhisper://license/YOUR-KEY
```

--------------------------------

### Preview Deletion of Old Superwhisper Folders (Bash)

Source: https://github.com/superultrainc/superwhisper-docs/blob/main/get-started/history-management.mdx

This bash command allows you to preview which Superwhisper recording folders would be deleted by the cleanup script without actually removing them. It uses `find` with the `-print` action to list the target directories. Adjust the path and time threshold as needed.

```bash
/usr/bin/find "$HOME/Documents/superwhisper/recordings" -mindepth 1 -maxdepth 1 -type d -name "[0-9]*" -mmin +1440 -print
```

--------------------------------

### Superwhisper Configuration File Location

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

Details the location of the default Superwhisper configuration folder and its contents. It also mentions the FileSync feature for cross-device synchronization, which can be enabled in the application's advanced settings.

```bash
# Default configuration folder
~/Documents/superwhisper/

# Contents:
# - History files (recordings and transcriptions)
# - Custom mode settings (modes/*.json)
# - Vocabulary and text replacements

# Enable FileSync to sync across devices with same license
# Settings > Advanced > FileSync toggle
```

--------------------------------

### Deepgram Cloud Models for Transcription

Source: https://context7.com/superultrainc/superwhisper-docs/llms.txt

Overview of Deepgram's cloud-based models for transcription. This table lists available models, their language support (multi-language or specific like 'en'), speed, accuracy ratings, and licensing information, useful for users requiring high-performance cloud transcription.

```markdown
| Model        | Languages | Speed | Accuracy | License |
|--------------|-----------|-------|----------|---------|
| Nova 3       | multi     | 7     | 8        | Pro     |
| Nova 2       | multi     | 7     | 7        | Pro     |
| Nova Medical | en        | 10    | 7        | Pro     |
```