parrot README

The project's README from github.com/humanitas-labs/parrot. As one markdown file: README.md.

parrot

parrot

Hold fn, speak, release. Your words appear at the cursor. On-device dictation for macOS.

1. Install

Download Parrot.dmg, drag Parrot to Applications, and open it. Turn on Parrot when macOS asks for Accessibility and the microphone. The first start downloads the speech model (about 150 MB).

Or from a terminal, which also installs the parrot command:

curl -fsSL https://perroquet.xyz/install.sh | sh

Requires macOS 14+ on Apple Silicon. Parrot is signed and notarized, so permissions survive updates, and it updates itself: it checks once a day, and Check for Updates… in its menu checks now. Upgrading from the command-line version: open the new app once and it replaces the old install.

2. Usage

  1. Click into any text field.
  2. Hold fn and speak. A small pill at the bottom of the screen shows the mic is live.
  3. Release. The transcript is pasted at the cursor, usually within 200–300 ms, and your clipboard is restored.

Choose Launch at login in the menu to start Parrot with your Mac. If fn is mapped to input source or emoji, parrot doctor shows how to fix it.

3. Dictionary

Add your names and technical terms to ~/.config/parrot/dictionary.json, and Parrot spells them your way. Edits apply on the next dictation. See docs/dictionary.md.

4. CLI

Command What it does
parrot Run in the foreground (^C to quit)
parrot setup One-time setup: permissions and model download
parrot doctor Check permissions and the fn key setting
parrot install --launch-at-login Start Parrot at login
parrot install --cli Link /usr/local/bin/parrot to Parrot.app
parrot install --uninstall Stop launching at login and remove logs
parrot models list List available models
parrot --model whisper-large-v3-turbo Larger, multilingual model
parrot --no-overlay Hide the recording pill
parrot --inject-mode type-unicode Type instead of paste (leaves the clipboard alone)

5. How it works

WhisperKit runs Whisper on the Apple Neural Engine via CoreML, AVAudioEngine captures the mic, a CGEventTap watches the hotkey, and a synthesized ⌘V pastes the result. Nothing leaves your Mac, and logs never contain what you said. See docs/architecture.md.

6. Build from source

swift build -c release && swift test
scripts/dev-install.sh      # build, sign, install Parrot.app, link the CLI

7. License

MIT

parrot (humanitas-labs/parrot)

Searching Database…

1.4K ·GitHub
Parrot
Что это такое?Parrot — это диктовка прямо на устройстве для macOS: зажмите клавишу fn, скажите что нужно, отпустите — и ваши слова появятся текстом там, где стоит курсор.
Это обычное приложение для Mac или терминальная утилита?И то и другое: оно ставится как Parrot.app из dmg-файла, а установка из терминала дополнительно добавляет команду parrot для настройки, моделей и опций.
Нужно ли что-то ещё установить, чтобы всё заработало?Нет, ничего: Parrot требует только два разрешения macOS и при первом запуске сам скачивает модель распознавания речи.
А если моя клавиша fn уже назначена на другое действие?Если fn переключает язык ввода или открывает панель эмодзи, запустите parrot doctor — он проверит ваши разрешения и настройку fn и подскажет, как разрешить конфликт.
Он будет работать на моём Mac?Только на Mac с Apple Silicon под macOS 14 или новее; на машинах с Intel и на старых версиях macOS не поддерживается.
Всё, что я говорю, уходит с моего Mac?Нет. WhisperKit запускает Whisper на Apple Neural Engine через CoreML, поэтому распознавание происходит полностью на устройстве, а в логах никогда не сохраняется то, что вы сказали.
Могу ли я научить его моим именам и техническим терминам?Да. Добавьте их в ~/.config/parrot/dictionary.json, и Parrot будет писать их так, как вы укажете; изменения вступают в силу со следующей диктовки.
Можно ли поставить модель побольше или мультиязычную?Да. parrot models list показывает, что доступно, а parrot --model whisper-large-v3-turbo запускает более крупную мультиязычную модель.
Он сам себя обновляет?Да. Parrot подписан и нотариально заверен, поэтому разрешения сохраняются после обновлений, и он раз в день проверяет новые версии; пункт Check for Updates в меню проверяет сразу.
Что можно настроить из командной строки?Скрыть индикатор записи с помощью --no-overlay или использовать --inject-mode type-unicode, чтобы текст вводился, а не вставлялся, и буфер обмена оставался нетронутым; parrot install --launch-at-login запускает Parrot вместе с Mac.
What are similar projects?lipflow, FluidVoice, SCM, better-voice, no-tipe-releases, phorminx, jot-gemini-transcribe-macOS, Handy
Which topics is it in?menu-bar-app, coreml, dictation, on-device-ai, transcription, local-ai, whisper, menu-bar, speech-to-text, speech-recognition, privacy-first, macos-app
Creator
humanitas-labs
Size
1.4 MB
Stars
1.4K
Updated
CommitOct 01Releasev0.2.4Oct 11
Age
5mo
Commits · 90 Days