Install Now
How to install moonshine-ai/moonshine. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
moonshine-ai/moonshine Installation Guide
How to install moonshine-ai/moonshine. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for moonshine-ai/moonshine. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i moonshine-ai/moonshineor
Install via npx
npx @hexmos/ipm i moonshine-ai/moonshinePrerequisites
Python
languageVersion: >=3.8
CMake
build toolXcode
IDEVersion: >=13.0
Android Studio
IDEVisual Studio
IDEOnnx Runtime
libraryManual Installation Methods
Manual installation instructions. How to install from GitHub source.
Python (pip)
pip install moonshine-voice
python -m moonshine_voice.download --language eniOS/MacOS (Xcode)
https://github.com/moonshine-ai/moonshine-swift/Android (Gradle)
implementation(libs.moonshine.voice)Linux (Source)
git clone https://github.com/moonshine-ai/moonshine.git
cd moonshine
cd core
mkdir build
cd build
cmake .. -DBUILD_SHARED_LIBS=ON
cmake --build .Windows (Visual Studio)
git clone https://github.com/moonshine-ai/moonshine.git
cd moonshine
examples\windows\cli-transcriber\download-lib.bat
cd examples\windows\cli-transcriber
msbuild cli-transcriber.sln /p:Configuration=Release /p:Platform=x64Raspberry Pi (pip)
sudo pip install --break-system-packages moonshine-voice
python -m moonshine_voice.download --language enPost Installation Steps
- For Python, run `python -m moonshine_voice.mic_transcriber --language en` to listen to the microphone and print updates to the transcript.
- For Python, run `python -m moonshine_voice.intent_recognizer` to listen for user-defined action phrases.
- For iOS, download and extract `ios-examples.tar.gz`, then open `Transcriber/Transcriber.xcodeproj` in Xcode.
- For Android, download and extract `android-examples.tar.gz`, then open the `Transcriber` folder in Android Studio.
- For Linux, after building, run `./moonshine-cpp-test`.
- For MacOS, download and extract `macos-examples.tar.gz`, then open `MicTranscription/MicTranscription.xcodeproj` in Xcode.
- For Windows, after building, navigate to `x64\Release` and run `cli-transcriber.exe --model-path <path from download> --model-arch <number from download>`.
- For Raspberry Pi, run `python -m moonshine_voice.mic_transcriber --language en`.