| 1 | <!-- Markdown with HTML --> |
| 2 | <div align="center"> |
| 3 | <picture> |
| 4 | <source media="(prefers-color-scheme: dark)" srcset="https://amical.ai/github-readme-header-dark.png"> |
| 5 | <source media="(prefers-color-scheme: light)" srcset="https://amical.ai/github-readme-header-light.png"> |
| 6 | <img alt="Amical" src="https://amical.ai/github-readme-header-light.png"> |
| 7 | </picture> |
| 8 | </div> |
| 9 | ย |
| 10 | <p align="center"> |
| 11 | <a href='http://makeapullrequest.com'> |
| 12 | <img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields'/> |
| 13 | </a> |
| 14 | <a href="https://opensource.org/license/MIT/"> |
| 15 | <img src="https://img.shields.io/github/license/amicalhq/amical?logo=opensourceinitiative&logoColor=white&label=License&color=8A2BE2" alt="license"> |
| 16 | </a> |
| 17 | <br> |
| 18 | <a href="https://amical.ai/community"> |
| 19 | <img src="https://img.shields.io/badge/discord-7289da.svg?style=flat-square&logo=discord" alt="discord" style="height: 20px;"> |
| 20 | </a> |
| 21 | </p> |
| 22 | ย |
| 23 | <p align="center"> |
| 24 | <a href="https://amical.ai">Website</a> - <a href="https://amical.ai/docs">Docs</a> - <a href="https://amical.ai/community">Community</a> - <a href="https://github.com/amicalhq/amical/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> |
| 25 | </p> |
| 26 | ย |
| 27 | ## Table of Contents |
| 28 | ย |
| 29 | - [โฌ๏ธ Download](#๏ธ-download) |
| 30 | - [๐ฎ Overview](#-overview) |
| 31 | - [โจ Features](#-features) |
| 32 | - [๐ฐ Tech Stack](#-tech-stack) |
| 33 | - [๐ค Contributing](#-contributing) |
| 34 | - [๐ License](#-license) |
| 35 | ย |
| 36 | ## โฌ๏ธ Download |
| 37 | ย |
| 38 | <p> |
| 39 | <a href="https://github.com/amicalhq/amical/releases/latest"> |
| 40 | <img src="https://amical.ai/download_button_macos.png" alt="Download for macOS" height="60"> |
| 41 | </a> |
| 42 | <a href="https://github.com/amicalhq/amical/releases/latest"> |
| 43 | <img src="https://amical.ai/download_button_windows.png" alt="Download for Windows" height="60"> |
| 44 | </a> |
| 45 | <a href="https://amical.ai/android"> |
| 46 | <img src="https://amical.ai/Store=Google%20Play,%20Type=Dark,%20Language=English.svg" alt="Get it on Google Play" height="60"> |
| 47 | </a> |
| 48 | <a href="https://amical.ai/beta"> |
| 49 | <img src="https://amical.ai/ios_beta_button.svg" alt="Apply for iOS Beta" height="60"> |
| 50 | </a> |
| 51 | </p> |
| 52 | ย |
| 53 | ### Homebrew (macOS) |
| 54 | ย |
| 55 | ```bash |
| 56 | brew install --cask amical |
| 57 | ``` |
| 58 | ย |
| 59 | ## ๐ฎ Overview |
| 60 | ย |
| 61 | Local-first AI Dictation app. |
| 62 | ย |
| 63 | Amical is an open source AI-powered dictation and note-taking app that runs entirely on your machine. |
| 64 | Powered by [Whisper](https://github.com/openai/whisper) for speech-to-text and open source LLMs for intelligent processing, Amical gives you the power of AI dictation with complete privacy. |
| 65 | ย |
| 66 | Context-aware dictation that adapts to what you're doing: drafting an email, chatting on Discord, writing prompts in your IDE, or messaging friends. Amical detects the active app and formats your speech accordingly. |
| 67 | ย |
| 68 | <p align="center"> |
| 69 | <img src="https://amical.ai/demo/dictation-demo-component.gif" alt="Amical dictation demo" width="600"> |
| 70 | </p> |
| 71 | ย |
| 72 | ## โจ Features |
| 73 | ย |
| 74 | > โ๏ธ - Done, โ - In Progress, โฏ - Planned |
| 75 | ย |
| 76 | ๐ Super-fast dictation with AI-enhanced accuracy โ๏ธ |
| 77 | ย |
| 78 | ๐ง Context-aware speech-to-text based on the active app โ๏ธ |
| 79 | ย |
| 80 | ๐ Smart voice notes โ summaries, tasks, structured notes โ |
| 81 | ย |
| 82 | ๐ MCP integration โ voice commands that control your apps โฏ |
| 83 | ย |
| 84 | ๐๏ธ Real-time meeting transcription (mic + system audio) โฏ |
| 85 | ย |
| 86 | ๐ง Extensible via hotkeys, voice macros, custom workflows โ๏ธ |
| 87 | ย |
| 88 | ๐ Privacy-first: works offline, one click setup of local models in-app โ๏ธ |
| 89 | ย |
| 90 | ๐ช Floating widget for frictionless start/stop with custom hotkeys โ๏ธ |
| 91 | ย |
| 92 | ## ๐ฐ Tech Stack |
| 93 | ย |
| 94 | - ๐ค [Whisper](https://github.com/openai/whisper) |
| 95 | - ๐ฆ [Ollama](https://ollama.ai) |
| 96 | - ๐งโ๐ป [Typescript](https://www.typescriptlang.org/) |
| 97 | - ๐ฅ๏ธ [Electron](https://electronjs.org/) |
| 98 | - โ๏ธ [Next.js](https://nextjs.org/) |
| 99 | - ๐จ [TailwindCSS](https://tailwindcss.com/) |
| 100 | - ๐ง๐ผโ๐จ [Shadcn](https://ui.shadcn.com/) |
| 101 | - ๐ [Better-Auth](https://better-auth.com/) |
| 102 | - ๐งโโ๏ธ [Zod](https://zod.dev/) |
| 103 | - ๐ [Jest](https://jestjs.io/) |
| 104 | - ๐ [Fumadocs](https://github.com/fuma-nama/fumadocs) |
| 105 | - ๐ [Turborepo](https://turbo.build/) |
| 106 | ย |
| 107 | ## ๐ค Contributing |
| 108 | ย |
| 109 | Contributions are welcome! Reach out to |