🚀

Getting Started

Quickstart guide to install and set up the VoxKit application

Judging by your presence here, I take it your ready to conduct research faster and with less technical overhead. You're in the right place, here's how to get started.

System Requirements

Make sure your system meets the following requirements before continuing:

  • 4GB RAM minimum (8GB recommended)
  • 20GB free disk space (models and datasets can be hefty)
  • macOS 26+ / Windows 10+ / Linux (testing in progress!)

Installation

Follow these steps to install VoxKit on your system:

  • Download the appropriate asset for your operating system from the VoxKit website (This Website). Click `download` in the Navigation menu above to do that.
  • If you plan to use Montreal Forced Aligner, be sure you have the CLI setup correctly prior to installation. See the current MFA documentation for instructions.
  • Once an asset is successfully downloaded, follow the correct instructions below for additional steps. If you're having issues see the troubleshooting section of the help page (go back), or email support at code@beckettfrey.com.

Choose your platform below for specific instructions.

macOS Installation

Open the dmg and drag voxkit to your Applications folder.

bash
# Disable quarantine mode for apps downloaded from the internet
# You won't be able to setup the app if you skip this
xattr -cr ../VoxKit.app

Windows Installation

Just Double click the executable you downloaded in the previous step and follow the prompts to setup VoxKit on your system. If you have issues, try running the executable as administrator.

Linux Installation

bash
# Testing in the works