Setup and Download
Install KatanA
Use a package manager for the fastest setup, or direct downloads via GitHub Releases.
Installation routes for macOS, Windows x86_64, and Linux x86_64.
This page is maintained alongside the repository to ensure it stays aligned with the latest platform distribution artifacts.
- 01
Supports Homebrew and Winget
- 02
Direct downloads available
- 03
Platform-specific notes included
Current Support
macOS / Windows x86_64 / Linux x86_64
Includes Homebrew and DMG for macOS, Winget and MSI for Windows, and Homebrew and tar.gz for Linux x86_64.
macOS
macOS + Homebrew
The recommended route for the fastest setup on macOS.
- The preferred method as suggested in the official README.
- Ready to use immediately after installation.
brew tap HiroyukiFuruno/KatanA && brew install --cask katana-desktopmacOS Manual Download
- Download the latest `KatanA-Desktop-x.y.z.dmg` from GitHub Releases.
- Move `KatanA Desktop.app` to your Applications folder.
- If necessary, run the Gatekeeper allowance command once before first launch.
- On macOS Sequoia (15.x), Gatekeeper may require this for non-notarized builds. You can also allow it via System Settings > Privacy & Security > Open Anyway after a failed launch.
xattr -cr /Applications/KatanA\ Desktop.appWindows x86_64
Winget is the fastest route on Windows. MSI is also available on GitHub Releases.
- Install via Winget or download `KatanA-windows-x86_64.msi` from GitHub Releases.
- Double-click the MSI to install.
- Start menu and desktop shortcuts are created automatically.
winget install HiroyukiFuruno.katana-desktopLinux x86_64
Homebrew is recommended if available. tar.gz is also provided on GitHub Releases.
- Install via Homebrew or download `KatanA-linux-x86_64.tar.gz` from GitHub Releases.
- Extract the archive.
- Run the executable directly.
brew tap HiroyukiFuruno/KatanA && brew install katana-desktopHow to Update
- KatanA features a built-in auto-update function.
- On macOS, use the "Update & Restart" button in the app when a new release is found.
- On Windows/Linux, the update dialog links directly to the latest asset.
- If initially installed via Homebrew on macOS, the first in-app update will automatically detach it from Homebrew to avoid management conflicts.
Optional Diagram Setup
Mermaid and ZenUML require no extra setup; PlantUML may require one additional runtime.
Mermaid
No Extra Setup
Mermaid diagrams, including ZenUML sequence diagrams, render in the current document flow.
PlantUML
Install Java Runtime
Run `brew install openjdk@25` and acquire `plantuml.jar` when opening a PlantUML document.
Draw.io
No Extra Setup
Draw.io diagrams are handled natively in the current workflow.
after install
After install (3 checks)
- Open workspace: verify README and spec files appear in the tree.
- Confirm diagrams: open a Mermaid document, including ZenUML sequence diagrams, or a PlantUML document and verify rendering.
- Check updates: run the in-app update check once and confirm channel behavior.
support
FAQ
PlantUML does not render
Install Java runtime first, then allow KatanA to fetch plantuml.jar.
macOS app is blocked
Use Open Anyway in Privacy & Security or apply the xattr command once.