Windows, macOS or Linux
Install Volath with the installer, the disk image, the AppImage or the package from the download page. Nothing else has to be installed for Volath itself.
Download the installer for your system, open it and follow the setup wizard. No terminal and no Node.js needed. It runs on your own machine. Your code, tickets and settings live in a local SQLite database, or in your own MySQL or MariaDB.
Step by step
Every step happens in the installer or in the app. Nothing is run from a terminal.
Pick the file for your system on the download page: the installer for Windows, the disk image for macOS, the AppImage or the Debian package for Linux.
Run the installer on Windows, drag Volath to Applications on macOS, or make the AppImage executable on Linux. The first launch can show a security warning because Volath is not code-signed yet.
The setup wizard opens on first launch. Paste the key from your customer account, or restore a backup. You also create the administrator account of this Volath here.
Pick the default AI provider and model: a CLI that is already on your machine, or an API key.
Give it a name and the folder of its git repository. Then open the Project settings and fill in the Git host token, owner and repository, branches and environments.
Create a ticket from the Board and follow it from To Do to Done through the steps of its workflow. Tickets, projects and settings stay in a database you control: SQLite on your computer by default.
Requirements
Most developers already have all of it except the Git host token.
Install Volath with the installer, the disk image, the AppImage or the package from the download page. Nothing else has to be installed for Volath itself.
Git, available in PATH.
At least one: a CLI (claude, codex, copilot, opencode) or an API key.
A token for your Git host with access to the repositories you work on, used for pull requests, reviews and CI. GitHub, GitLab (including self-hosted) or Bitbucket Cloud, chosen per project in Settings › Git host.
Only for live testing. Volath downloads it the first time you run a live test.
Your system
The installer for each system is on the download page, with its SHA-256 checksum.
Run the .exe installer. SmartScreen may ask you to confirm the first launch.
Open the .dmg and drag Volath to Applications. Choose Open Anyway if macOS asks.
Make the AppImage executable and start it, or install the .deb package.
Configuration
There is no configuration file to edit. Settings are edited in the app and stored in the database of Volath: SQLite on your computer by default.
Board, notifications, AI providers and models, review rules, GitHub pull request behaviour, Figma, plugins, data and backups, version and updates.
The project's name, folder and description, plus overrides of the general settings, and the things that only make sense per project: GitHub token, owner and repository, branches, environments, testing, New Relic, SonarCloud and Dependabot. An empty field uses the general value.
For developers
The installer is the way to run Volath day to day. If you want to read the code or change it, there is a separate guide to run it from source.
It runs on your own machine. Your code, tickets and settings live in a local SQLite database, or in your own MySQL or MariaDB.