{"id":47300348,"url":"https://github.com/hiroyukifuruno/katana","last_synced_at":"2026-04-29T02:12:21.892Z","repository":{"id":344929481,"uuid":"1181564363","full_name":"HiroyukiFuruno/KatanA","owner":"HiroyukiFuruno","description":"multi platform desttop markdown ediiter application.","archived":false,"fork":false,"pushed_at":"2026-04-23T23:28:28.000Z","size":14666,"stargazers_count":10,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-24T01:38:21.003Z","etag":null,"topics":["linux-amd64","mados","markdown","mermaid","plantuml","windows-amd64"],"latest_commit_sha":null,"homepage":"https://katana-desktop.katana-projects.org/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HiroyukiFuruno.png","metadata":{"files":{"readme":"README.ja.md","changelog":"CHANGELOG.ja.md","contributing":"CONTRIBUTING.ja.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"HiroyukiFuruno"}},"created_at":"2026-03-14T10:10:15.000Z","updated_at":"2026-04-23T23:15:09.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/HiroyukiFuruno/KatanA","commit_stats":null,"previous_names":["hiroyukifuruno/katana"],"tags_count":112,"template":false,"template_full_name":null,"purl":"pkg:github/HiroyukiFuruno/KatanA","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiroyukiFuruno%2FKatanA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiroyukiFuruno%2FKatanA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiroyukiFuruno%2FKatanA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiroyukiFuruno%2FKatanA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HiroyukiFuruno","download_url":"https://codeload.github.com/HiroyukiFuruno/KatanA/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiroyukiFuruno%2FKatanA/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32407232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T19:38:08.556Z","status":"online","status_checked_at":"2026-04-29T02:00:06.602Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux-amd64","mados","markdown","mermaid","plantuml","windows-amd64"],"created_at":"2026-03-17T01:04:26.395Z","updated_at":"2026-04-29T02:12:21.886Z","avatar_url":"https://github.com/HiroyukiFuruno.png","language":"Rust","funding_links":["https://github.com/sponsors/HiroyukiFuruno"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/icon.iconset/icon_128x128.png\" width=\"128\" alt=\"KatanA Desktop\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eKatanA Desktop\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  macOS, Windows, Linux 向けの高速・軽量なMarkdownワークスペース — Rustとeguiで構築。\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\u003ca href=\"https://katana-desktop.katana-projects.org/\"\u003e🌐 公式ウェブサイト\u003c/a\u003e\u003c/strong\u003e | \u003cstrong\u003e\u003ca href=\"https://katana-desktop.katana-projects.org/docs/getting-started\"\u003e📚 ドキュメント\u003c/a\u003e\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"License: MIT\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/HiroyukiFuruno/KatanA/actions/workflows/test-and-build.yml\"\u003e\u003cimg src=\"https://github.com/HiroyukiFuruno/KatanA/actions/workflows/test-and-build.yml/badge.svg\" alt=\"CI\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/HiroyukiFuruno/KatanA/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/HiroyukiFuruno/KatanA\" alt=\"Latest Release\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/HiroyukiFuruno/homebrew-katana\"\u003e\u003cimg src=\"https://img.shields.io/badge/homebrew-cask-orange?logo=homebrew\" alt=\"Homebrew\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey\" alt=\"Platform: macOS | Windows | Linux\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"README.md\"\u003eEnglish\u003c/a\u003e | 日本語\n\u003c/p\u003e\n\n---\n\n## KatanA とは\n\n**KatanA** という名前は、日本語の **「刀（かたな）」** に由来しています。精密に鍛え上げられた、鋭利な刃物です。\n\n開発における複雑な課題を、刀のように **鋭く、的確に切り崩していきたい** — そんな思いからこのプロジェクトは命名されました。問題をひとつずつ、切れ味よく解決していくためのツールでありたいという願いが込められています。\n\nKatanA Desktop は、仕様書や技術ドキュメントを扱う開発者のために設計された、macOS, Windows, Linux向けの高速・軽量なMarkdownワークスペースです。\n\n末尾の大文字 **A** は **「AI」** と **「Agent」** を表しています。KatanA は AIエージェントと共に仕様駆動開発を行う時代のために設計されたツールであり、Markdownの仕様書が人間と AI の橋渡しとなる世界を見据えています。**Katana × AI Agent = KatanA.**\n\n---\n\n## 背景\n\n**2026年**現在、ソフトウェア開発は **AIエージェント** の台頭により急速に進化しています。AIがコードの作成、レビュー、メンテナンスを支援する時代です。\n\nこの流れと並行して、**仕様駆動開発（SDD: Spec-Driven Development）** が注目されています。実装の前に仕様、アーキテクチャ記述、タスクを定義する開発手法であり、これらの仕様は通常 **Markdownドキュメント** として記述され、開発者とAIエージェント双方の共通基盤となります。\n\nこのリポジトリは、AIエージェントの活用を前提とした開発フローで運用されています。\nリポジトリローカルの skill は `.agents/skills/` を正本として管理します。\n他のAIエージェントが別の skill ディレクトリ階層を要求する場合は、`.agents/skills/` の同一内容をその期待パスへコピーして対応し、派生版を別管理しません。\n\nKatanA 自体も、**Codex（OpenAI の公式AIコーディングエージェント）を中心にした AIエージェント開発フロー**で開発しています。\n主に **[Codex](https://openai.com/codex)** を使いながら、実装、レビュー、調査、ドキュメント整理、リリース準備など、用途に応じて複数のAIエージェントを組み合わせています。\nこれは、KatanA が支援したい「人間とAIエージェントが同じMarkdown仕様を見ながら進める開発」の実践でもあります。\n\n### AIエージェント開発における必須ツール\n\nトークン消費の抑制とコンテキストウィンドウの肥大化を防ぐため、本リポジトリで活動するすべてのAIエージェントには **[rtk](https://github.com/fission-ai/rtk)** の利用が **必須** 化されています。\n\nAIエージェントは、テスト、リンター、ビルドなどの出力が多いコマンドを実行する際、必ず `rtk` でラップして出力をフィルタリング・要約してから取り込む必要があります。\n\nしかし、既存のMarkdownツールの多くは：\n\n- 技術ドキュメントのワークフローに最適化されていない汎用エディタか、\n- 不必要に複雑な重量級のナレッジ管理ツールのどちらかです。\n\n# KatanA Desktop はこの問題を解決するために生まれました\n\nKatanAの目標は、**シンプルで高速、ワークスペース指向のMarkdown環境** を提供し、開発者がSDDワークフローで使用するドキュメントを簡単に **閲覧・編集** できるようにすることです。\n\n---\n\n## 主な機能\n\n- **ライブスプリットビュープレビュー** — 左側で編集、右側でレンダリング結果をスクロール同期しながら表示\n- **ダイアグラムレンダリング** — Mermaid、PlantUML、Draw.ioのフェンスコードブロックをファーストクラスでサポート\n- **GitHub Flavored Markdown** — テーブル、取り消し線、タスクリスト、脚注、自動リンク\n- **ワークスペース対応** — フォルダを開き、統合ファイルツリーからファイルをナビゲーション\n- **タブバー** — VSCodeスタイルのタブで複数ドキュメントを同時に開く\n- **i18n（国際化）** — UI文字列は完全にローカライズ済み（英語・日本語同梱）\n- **高速なネイティブパフォーマンス** — Rustとeguiでビルドされたネイティブバイナリ。Electron不要、Node.js不要\n\n---\n\n## インストール\n\n\u003e macOS (Apple Silicon / Intel), Windows, Linux で利用可能です。\n\n### macOS\n\n#### Homebrew（macOS推奨）\n\n```sh\nbrew tap HiroyukiFuruno/KatanA \u0026\u0026 brew install --cask katana-desktop\n```\n\n追加の手順は不要で、すぐに使い始められます。\n\n#### 手動ダウンロード (macOS)\n\n1. [Releasesページ](https://github.com/HiroyukiFuruno/KatanA/releases/latest) にアクセス\n2. 最新の `KatanA-Desktop-x.y.z.dmg` をダウンロード\n3. DMGを開き、**KatanA Desktop.app** を **アプリケーション** フォルダにドラッグ\n4. 以下のコマンドを1回実行して、アプリの起動を許可してください：\n\n```sh\nxattr -cr /Applications/KatanA\\ Desktop.app\n```\n\n\u003e **注意:** macOS Sequoia（15.x）では、Appleの公証を受けていないアプリの起動にこのコマンドが必要です。\n\u003e または、初回起動を試みた後に **システム設定 → プライバシーとセキュリティ → 「このまま開く」** からも許可できます。\n\n### Windows\n\n#### Winget (推奨)\n\nWindows 10 / 11 では、パッケージマネージャーの `winget` を使用して簡単にインストールできます。\n\n```powershell\nwinget install HiroyukiFuruno.katana-desktop\n```\n\n#### 手動ダウンロード (Windows)\n\n[Releasesページ](https://github.com/HiroyukiFuruno/KatanA/releases/latest) からファイルを手動でダウンロードすることも可能です。\n\n- **ポータブル ZIP**: アーカイブを任意の場所に展開し、中の `katana-desktop.exe` を実行します。\n- **MSI インストーラー**: スタートメニューとデスクトップショートカットを自動作成します。※現在コード署名されていないため、ダウンロード・実行時に Windows SmartScreen の警告が表示される場合があります。その場合は「詳細表示」→「実行」を選択してください。\n\n### Linux\n\n#### Homebrew (推奨)\n\n```sh\nbrew tap HiroyukiFuruno/KatanA \u0026\u0026 brew install katana-desktop\n```\n\n#### 手動ダウンロード (Linux)\n\n1. [Releasesページ](https://github.com/HiroyukiFuruno/KatanA/releases/latest) にアクセス\n2. `KatanA-linux-x86_64.tar.gz` をダウンロード\n3. アーカイブを展開し、実行ファイルを起動\n\n### アプリのアップデート\n\nKatanA Desktop には自動アップデータが内蔵されています。一度インストールすれば（Homebrew経由でも手動でも）、新しいリリースが利用可能になった際に通知されます。\n\n- **macOS:**アプリ内の**Restart\"** ボタンをクリックするだけで自動的に更新されます。Homebrew経由で初回インストールした場合、アプリ内から初めてアップデートを行った際に、二重管理を防ぐため自動的に `brew untap` されます。\n- **Windows / Linux:** アップデート時のダイアログから、最新のアセットをダウンロードするための Release ページリンクが表示されます。\n\n---\n\n## 現在のステータス\n\nKatanA Desktop は **活発に開発中** です。最新バージョンと変更履歴は [Releasesページ](https://github.com/HiroyukiFuruno/KatanA/releases/latest) をご覧ください。\n\n現在利用可能な主な機能：\n\n- ワークスペースベースのMarkdown閲覧\n- ダイアグラムサポート（Mermaid / PlantUML / draw.io）\n- スクロール同期付きスプリットプレビュー\n- 高速なネイティブデスクトップパフォーマンス（Rustベース）\n\nプロジェクトは急速に進化しており、新機能や改善が頻繁にリリースされています。\n\n---\n\n## ダイアグラム表示の準備\n\nKatanA は Markdown のフェンスコードブロック内の Mermaid、PlantUML、Draw.io ダイアグラムをサポートしています。Mermaid と PlantUML のレンダリングには外部ツールが必要です。\n\n### Mermaid\n\nMermaid CLI をグローバルにインストールしてください：\n\n```sh\nnpm i -g @mermaid-js/mermaid-cli\n```\n\nインストール後、`mmdc` は自動的に検出されます。追加の設定は不要です。\n\n### PlantUML\n\n1. Java ランタイムをインストール：\n\n```sh\nbrew install openjdk@25\n```\n\n1. PlantUML ブロックを含む Markdown ファイルを KatanA で開き、プレビューペインに表示される **⬇ ダウンロード** ボタンをクリックしてください。`plantuml.jar` が自動的にダウンロードされます。\n\n### Draw.io\n\nDraw.io ダイアグラムはネイティブでレンダリングされます — 外部ツールは不要です。\n\n---\n\n## プロジェクトの目標\n\nKatanAは開発者が以下を実現するためのツールを目指しています：\n\n- Markdownドキュメントを効率的に閲覧・ナビゲーション\n- 仕様駆動ワークフローとの連携\n- 現代的なAIアシスト開発とのドキュメント統合\n\n長期的なビジョンは、モダンな開発ツールを補完する **軽量なドキュメントワークスペース** の構築です。\n\n---\n\n## アイデアを募集しています\n\nこのプロジェクトはまだ初期段階にあります。機能のアイデア、使い勝手の提案、バグ報告などを歓迎します。\nKatanAが開発者のドキュメントワークフローをどのように改善できるかアイデアがあれば、ぜひ[issue](https://github.com/HiroyukiFuruno/KatanA/issues)や[discussion](https://github.com/HiroyukiFuruno/KatanA/discussions)を開いてください。\n\n---\n\n## コントリビューター向け\n\nKatanA の未来を一緒に形作っていきたい方は、ぜひ以下をお読みください：\n\n- 🤝 **[Contributing Guide](CONTRIBUTING.ja.md)** — ディスカッションへの参加方法、デザインへのフィードバック提供、AIエージェント支援ワークフローによる協力方法について。\n\n---\n\n## オープンソースへのコミットメント\n\nKatanA Desktopはオープンソースプロジェクトです。\n\n**コアな機能を無料で提供し続ける** ことをお約束します。特に運用コストがかからない機能については：\n\n- Markdownの閲覧\n- ワークスペースナビゲーション\n- ドキュメントブラウジング\n- ダイアグラムレンダリング\n\n---\n\n## 今後の展望\n\n一部の高度な機能は外部サービスや運用コストが必要になる可能性があります。\n\n持続可能性のために、プロジェクトは以下を導入する可能性があります：\n\n- オプションの有料機能（例: AIアシストツール）\n- アプリケーション内の小規模な広告\n\nただし、**コアなドキュメント機能は引き続き無料** です。\n\n---\n\n## 開発者の方へ\n\nソースからビルドしたい方、コントリビュートしたい方、アーキテクチャを理解したい方へ：\n\n- 📖 **[開発ガイド](docs/development-guide.ja.md)** — セットアップ、ビルド、テスト、プロジェクト構造\n- 📐 **[コーディング規約](docs/coding-rules.ja.md)** — コードスタイル、規約、品質ゲート\n- 🏗️ **[Architecture Decisions](docs/adr/)** — 設計の根拠とADR\n\n---\n\n## プロジェクトを支援する\n\nKatanAが役に立ったと思っていただけたら、スポンサーシップで開発を支援できます。\n\n\u003ca href=\"https://github.com/sponsors/HiroyukiFuruno\"\u003e\u003cimg src=\"https://img.shields.io/badge/Sponsor-❤️-ea4aaa?style=for-the-badge\u0026logo=github-sponsors\" alt=\"Sponsor\"\u003e\u003c/a\u003e\n\n支援は以下に活用されます：\n\n- 開発時間\n- インフラ\n- ツール費用\n\n👉 **[スポンサーになる](https://github.com/sponsors/HiroyukiFuruno)**\n\n- ⭐ このリポジトリにスターをつける — 他の人がKatanAを見つけるのに役立ちます\n- KatanAを役立ててくれそうな人にシェアする\n\n---\n\n## 付録: Windows 環境セットアップ\n\nダイアグラムレンダリング（Mermaid / PlantUML）に必要な外部ツールの Windows でのインストール手順です。\n\n\u003cdetails\u003e\n\u003csummary\u003eNode.js のインストール（Mermaid CLI に必要）\u003c/summary\u003e\n\nMermaid CLI (`mmdc`) の実行には Node.js が必要です。\n\n```powershell\nwinget install -e --id OpenJS.NodeJS.LTS\n```\n\nインストール後、新しいターミナルを開いて以下を実行してください：\n\n```powershell\nnpm i -g @mermaid-js/mermaid-cli\n```\n\n\u003e **エラーが出た場合:** `winget` でエラーが発生する場合は、[Node.js 公式サイト](https://nodejs.org/) から直接ダウンロードしてインストールしてください。\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eJDK のインストール（PlantUML に必要）\u003c/summary\u003e\n\nPlantUML のレンダリングには Java ランタイムが必要です。\n\n```powershell\nwinget install -e --id Oracle.JDK.25\n```\n\n\u003e **エラーが出た場合:** `winget` のソースが古い場合にエラーが発生することがあります。以下のコマンドでソースを更新してから再実行してください：\n\u003e\n\u003e ```powershell\n\u003e winget source update\n\u003e winget install -e --id Oracle.JDK.25\n\u003e ```\n\n\u003c/details\u003e\n\n---\n\n## ライセンス\n\nKatanA Desktop は [MIT License](LICENSE) の下でリリースされています。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiroyukifuruno%2Fkatana","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiroyukifuruno%2Fkatana","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiroyukifuruno%2Fkatana/lists"}