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 上能用吗？只能在搭载 macOS 14 或更新系统的 Apple Silicon Mac 上运行；Intel 机型和更旧的 macOS 版本不受支持。
我说的话会离开我的 Mac 吗？不会。WhisperKit 通过 CoreML 在 Apple 神经引擎上运行 Whisper，识别完全在本地进行，日志里也从不包含你说过的内容。
我能教它记住我的人名和专业术语吗？可以。把它们添加到 ~/.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, speech-swift, no-tipe-releases, phorminx, jot-gemini-transcribe-macOS
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