Mermaid
追加設定不要
Mermaid図とZenUMLシーケンス図は現在の文書フロー内で表示されます。
現在の対応状況
macOS / Windows x86_64 / Linux x86_64
macOSはHomebrewとDMG、WindowsはWingetとMSI、Linux x86_64はHomebrewとtar.gzによるインストールをサポートしています。
macOS
macOS + Homebrew
macOSで最短導入したい場合の推奨ルートです。
- 公式READMEでも推奨されている導入方法です。
- インストール直後にそのまま利用できます。
brew tap HiroyukiFuruno/KatanA && brew install --cask katana-desktopmacOS 手動導入
macOS手動ダウンロード
- GitHub Releasesから最新の `KatanA-Desktop-x.y.z.dmg` を取得します。
- `KatanA Desktop.app` をApplicationsに移動します。
- 必要に応じて初回起動前にGatekeeper許可コマンドを1回実行します。
- macOS Sequoia (15.x) では、Appleの公証 (Notarization) がないビルドに対してGatekeeperがこのコマンドの実行を要求する場合があります。初回起動に失敗した場合は、システム設定 > プライバシーとセキュリティ > 「このまま開く」から許可することも可能です。
xattr -cr /Applications/KatanA\ Desktop.appWindows x86_64
WindowsではWingetが最短です。GitHub ReleasesにはMSIも用意されています。
- Wingetで入れるか、GitHub Releasesから `KatanA-windows-x86_64.msi` を取得します。
- MSIをダブルクリックしてインストールします。
- スタートメニューとデスクトップショートカットは自動作成されます。
winget install HiroyukiFuruno.katana-desktopLinux x86_64
利用可能ならHomebrewを推奨します。GitHub Releasesにはtar.gzも用意されています。
- Homebrewで入れるか、GitHub Releasesから `KatanA-linux-x86_64.tar.gz` を取得します。
- アーカイブを展開します。
- 実行ファイルを直接起動します。
brew tap HiroyukiFuruno/KatanA && brew install katana-desktopアップデート方法
- KatanAにはアプリ内の自動更新機能が備わっています。
- macOSでは新しいリリースがある場合、アプリ内の更新ボタンから再起動付きで適用します。
- WindowsおよびLinuxでは、アップデートダイアログから最新のアセットへ直接アクセスできます。
- macOSでHomebrewを使用して導入した場合、二重管理を防ぐため、初回のアプリ内更新時に自動的にHomebrewの管理下から外れます。
任意のダイアグラム設定
Mermaid図とZenUMLシーケンス図は追加設定不要です。追加ツールが必要になるのはPlantUMLのみです。
PlantUML
Javaランタイム を導入
`brew install openjdk@25` などの方法でJavaランタイムをインストールしてください。`plantuml.jar` は、最初にPlantUMLドキュメントを開いた際に自動的に取得されます。
Draw.io
追加セットアップ不要
Draw.io図は現行ガイダンスではネイティブに扱えます。
導入後
導入後の3確認
- ワークスペースを開く: README と仕様書がツリーに見えることを確認。
- 図を確認: Mermaid文書（ZenUMLシーケンス図を含む）またはPlantUML文書を開いて描画を確認。
- 更新を確認: アプリ内の更新確認を1回実行して挙動を確認。
サポート
FAQ
PlantUML が表示されない
先に Java runtime を導入し、PlantUML 文書を開いた時に jar 取得を許可してください。
macOS でアプリを開けない
Privacy & Security の Open Anyway または xattr コマンドを1回実行してください。