Files
hearbit-ai-app/README.md
2026-01-20 10:16:41 +01:00

102 lines
3.6 KiB
Markdown

# Hearbit AI 🦉🎙️
**Hearbit AI** is your professional meeting assistant for macOS. It records both your microphone and system audio (e.g., Teams, Zoom), transcribes it with high precision using Infomaniak's Whisper API, and generates intelligent, structured summaries.
![App Icon](src-tauri/icons/128x128@2x.png)
## ✨ Features
* **🎙️ Dual-Channel Recording**: seamlessly capture your voice and meeting audio from apps like Microsoft Teams, Zoom, or Google Meet.
* **🧠 Powered by Infomaniak AI**:
* **Precision Transcription**: Standard-compliant formatting with **second-by-second timestamps** (e.g., `[00:12]`).
* **Smart Summaries**: Uses advanced LLMs (Mixtral, Llama 3) to create actionable meeting notes.
* **📝 Professional Templates**: Comes with 3 built-in expert prompts:
* **Meeting Protocol**: For general business meetings.
* **1:1 / Jour Fixe**: For confidential personnel discussions.
* **Client Meeting**: For official, client-ready documentation.
* **💾 Auto-Save**: All recordings and summaries are saved locally to your history.
* **🔒 Privacy-First**: Data is processed securely via your own Infomaniak API keys.
---
## 🚀 Getting Started
### 1. Prerequisites
* **macOS** (Apple Silicon or Intel).
* **Infomaniak AI Account**: You need an API Key and Product ID from the [Infomaniak Developer Portal](https://manager.infomaniak.com/).
### 2. Installation
1. Download the latest `.dmg` file from the [Releases page](#).
2. Open the `.dmg` and drag **Hearbit AI** to your Applications folder.
3. Launch the app.
---
## 🎧 Recording System Audio (Teams, Zoom, etc.)
To record clear meeting audio from other applications, you need a "virtual cable". We recommend **BlackHole 2ch**.
1. **Install BlackHole**: Download and install [BlackHole 2ch](https://existential.audio/blackhole/).
2. **Create a Multi-Output Device** (So you can hear the audio too!):
* Open **Audio MIDI Setup** on your Mac.
* Create a "Multi-Output Device".
* Select both **BlackHole 2ch** AND your **Headphones/Speakers**.
* *Tip: Use this Multi-Output Device as your SPEAKER in Teams/Zoom.*
![Multi-Output Device Setup](docs/screenshots/multi_output_setup.png)
3. **Create Aggregate Device (Optional)**:
* If you want to record BOTH your Microphone and System Audio, create an **Aggregate Device**.
* Select **BlackHole 2ch** AND your **Microphone**.
![Aggregate Device Setup](docs/screenshots/aggregate_device_setup.png)
4. **Select Input in Hearbit AI**:
* In Hearbit AI, select **BlackHole 2ch** (or your new Aggregate Device) as the **Input Device**.
---
## 🛠️ Usage Guide
1. **Configuration**:
* Click the **Settings** (gear icon).
* Enter your **Infomaniak API Key** and **Product ID**.
* (Optional) Customize where recordings are saved.
2. **Recording**:
* Choose your **Template** (e.g., "Meeting Protocol").
* Select your **Input Device**.
* Click **Start Recording**.
3. **Processing**:
* Click **Stop** when finished.
* The app will transcribe the audio (with timestamps!) and generate a summary based on your selected template.
* You will be automatically taken to the **Transcription** tab to review the results.
---
## 👨‍💻 Development
Built with **Tauri**, **React**, and **TypeScript**.
### Setup
```bash
npm install
```
### Run Locally
```bash
npm run tauri dev
```
### Build for Production
```bash
npm run tauri build
```
*The build artifact will be located in `src-tauri/target/release/bundle/dmg/*`*
---
## 📄 License
Property of Livtec. All rights reserved.