プロジェクト概要

markdownfs(略称 mdfs)は、Markdown ファイル専用に設計された仮想ファイルシステムです。Rust で構築され、高性能なメモリストレージと豊富な操作インターフェースを提供します。従来のファイルシステムの概念をバージョン管理や権限管理と組み合わせ、AI Agent ワークスペースの構築や構造化された Markdown 管理が必要なシーンに最適です。

リポジトリ:https://github.com/subramanya1997/markdownfs

主な機能

マルチモーダルアクセス

mdfs は 5 つの使用方法を提供し、ターミナルから Web、AI 統合まで全シーンをカバーします:

方法エントリポイントユースケース
CLI/REPLmarkdownfs バイナリターミナル対話操作
HTTP/REST APImdfs-serverWeb アプリ、サービス統合
MCP Servermdfs-mcpCursor、Claude などの AI Agent
TypeScript SDKnpm markdownfsNode 18+/ブラウザ環境
Python SDKPyPI markdownfsPython 3.9+ プロジェクト

Unix スタイルのコマンドライン

Linux に慣れ親しんだユーザーには親しみやすい——mdfs は一般的なファイル操作コマンドをサポートします:

  • lscdpwd ディレクトリナビゲーション
  • touchmkdirrm ファイル操作
  • catwrite コンテンツ読み書き
  • chmodchown 権限管理
  • パイプとリダイレクト対応

Git 方式のバージョン管理

コンテンツアドレス指定ストレージ(CAS)とバージョン履歴を内蔵:

  • commit スナップショット作成
  • log 変更履歴の表示
  • revert 指定バージョンへのロールバック
  • 自動重複排除ストレージ

マルチユーザーの権限システム

完全な UNIX スタイルの権限モデル:

  • ユーザーとグループ管理
  • ファイルレベルの権限制御(読み取り/書き込み/実行)
  • 管理者権限の委譲
  • チームワークスペース対応

並列安全性

tokio::RwLock ベースのコア設計により、複数リーダー/単一ライターの安全な並列アクセスを保証。サーバー展開にも適しています。

インストール方法

ソースからコンパイル

git clone https://github.com/subramanya1997/markdownfs.git
cd markdownfs
cargo build --release

コンパイル後、3 つのバイナリが生成されます:

  • markdownfs — CLI/REPL 対話ツール
  • mdfs-server — HTTP サーバー
  • mdfs-mcp — MCP プロトコルサーバー

TypeScript SDK

npm install markdownfs
# または Bun を使用
bun add markdownfs

Python SDK

pip install markdownfs

使用例

CLI クイックスタート

初回起動時に管理者アカウントの作成が必要です:

$ cargo run --release --bin markdownfs

markdownfs v0.2.0 Markdown Virtual File System

Welcome! Let's set up your account.
Admin username: alice

Created admin 'alice' (uid=1, groups=[alice, wheel])
Home directory: /home/alice

alice@markdownfs:~ $ touch hello.md
alice@markdownfs:~ $ write hello.md # mdfs へようこそ
alice@markdownfs:~ $ cat hello.md
# mdfs へようこそ

HTTP サーバーの起動

MARKDOWNFS_LISTEN=127.0.0.1:3000 cargo run --release --bin mdfs-server

サーバーは完全な REST API を提供し、リモートファイル操作とバージョン管理をサポートします。

MCP 統合(Cursor/Claude)

mdfs を MCP クライアント設定に追加:

{
  "mcpServers": {
    "mdfs": {
      "command": "/path/to/mdfs-mcp",
      "env": {
        "MARKDOWNFS_DATA_DIR": "/path/to/data"
      }
    }
  }
}

設定後、AI Agent は Markdown ワークスペースでドキュメントの作成、読み取り、検索、バージョン管理を直接行えます。

ユースケース

  1. AI Agent ワークスペース:Agent への永続的な Markdown メモリ、検査可能な成果物、検索とロールバック機能を提供
  2. チームナレッジベース:権限制御とバージョン履歴付きの多ユーザー協働 Markdown ドキュメント管理
  3. 個人メモシステム:Git 方式のバージョン管理を組み合わせたローカルノート保存
  4. アプリケーションバックエンド:構造化された Markdown ストレージが必要な Web アプリやツール

プロジェクト状況

markdownfs は比較的新しいプロジェクト(2026 年 4 月作成)で、現在 189 スター、活発に更新されています。MIT ライセンスにより自由な使用と二次開発が可能です。詳細なユーザー管理、バージョン管理、HTTP API、MCP 統合ガイドを含む充実したドキュメントが提供されています。

関連プロジェクト

より伝統的な Markdown ツールが必要な場合:

  • leaf — ターミナル Markdown ビューアー(本站昨日のおすすめ)
  • glow — Charm 製 Markdown リーダー
  • Obsidian — ローカルファーストのノートアプリ

markdownfs は Markdown ツールエコシステムの空白を埋める存在です:ファイルシステムの信頼性、バージョン管理の確実性、現代の API の柔軟性を、Markdown 最適化されたパッケージに結合しています。AI ネイティブアプリケーションの構築や構造化された Markdown 管理が必要な開発者にとって、探索に値する基盤インフラストラクチャを提供しています。