Skip to content

Apricity7117/mindfs

 
 

Repository files navigation

MindFS

English | 简体中文

AI Agent Remote Access Gateway · Result Visualization

Access your personal AI agents and workstation data anywhere, anytime through MindFS.


Screenshots

MindFS desktop UI

MindFS mobile UI


Features

Agent Sessions

  • Multi-Agent support: Claude Code · OpenAI Codex · Gemini CLI · Cursor · GitHub Copilot · Cline · Augment · Kimi · Kiro · Qwen · Qoder · Pi · OpenCode · OpenClaw — installed agents are detected automatically.
  • Real-time streaming: Token-by-token output pushed to the browser; tool calls, thought traces, permission prompts, and remaining context-window capacity are rendered live as structured, collapsible cards.
  • Flexible switching: Switch agents or models mid-session; all agents share the same context — no need to re-explain the background.
  • Session search: Search by session title or conversation content, then jump straight to the matched session and snippet.
  • External session both-way import&synchronization: Browse existing sessions from supported agent CLIs, import one into MindFS, and continue it as a native MindFS session. MindFS session can resumed in agent cli too. Bidirectional synchronization is also possible.
  • Binding persistence and recovery: MindFS persists the mapping between its internal session and the underlying agent session, so the link can be restored after service restarts and follow-up messages continue on the same agent session when available.
  • Rich media input: Attach files and images directly in your messages.
  • Multi-device sync: Access the same instance from multiple devices simultaneously with live session sync.

File Access

  • Multiple projects: Manage several directories at once; sessions are organized per project and stay independent.
  • Self-hosted data: All conversation history, file metadata, and view config are stored under the project's .mindfs/ subdirectory — migration and backup is just a folder copy.
  • File tree browser: Full directory navigation with file preview; Markdown, images, and code all have dedicated renderers.

Interaction

  • / slash commands: Type / to trigger a command palette and quickly run preset operations.
  • @ file references: Type @ to trigger path completion and attach any file as context for the agent.
  • # quick prompts: Type # to trigger your saved prompt shortcuts inline.
  • Bidirectional file–session linking: Jump from a file to the session that created it, or from a session to all files it touched.
  • Android, Browser app (PWA): Install to desktop or mobile home screen for a native-like experience — no app store required.
  • Mobile-optimized UI: Bottom action bar within thumb reach, independent panel swipe navigation, input box adapts to the soft keyboard.

Access Modes

  • Local mode: Accessible in the browser on the local machine immediately after startup — no account or configuration needed.
  • Relay remote mode: Access your local instance from anywhere on the public internet without opening firewall ports, via an encrypted tunnel through a9gent.com. Click the bind button in the local UI to activate.
  • Private channel: Use a private network (e.g. Tailscale) and access directly via ip:port.
  • End-to-end encryption: Sessions and files can be protected with end-to-end encryption.

Plugin System

  • Custom views: A plugin is a custom view for a file, following the pattern: receive file content → parse → render UI.
  • Agent-generated plugins: Tell the agent "implement a txt novel reader" and it generates the plugin — all txt files are then displayed as a reading experience.
  • Interaction loop: Plugins can register action buttons that send structured commands to the agent, completing the loop: customize plugin → browse file → agent interaction.

Installation

  • Single binary: The production build is a statically compiled binary with all web assets embedded, and the install package is under 10 MB.
  • Zero dependencies: No Node.js, Docker, or daemon manager required on the host.
  • Cross-platform: macOS (Intel + Apple Silicon), Linux (x86-64, ARM64, ARMv7), Windows (x86-64, ARM64).

Quick Start

Prerequisites

MindFS does not include any AI model — you need at least one Agent CLI installed locally. Choose what works for you:

Agent Install
Claude Code https://code.claude.com/docs/en/quickstart
OpenAI Codex https://developers.openai.com/codex/cli
Gemini CLI https://geminicli.com/
Cursor https://cursor.com/cn/cli
GitHub Copilot https://github.com/features/copilot/cli
Cline https://cline.bot/kanban
Augment https://www.augmentcode.com/product/CLI
Kiro https://kiro.dev/cli/
OpenCode https://opencode.ai/
OpenClaw https://docs.openclaw.ai/
Kimi https://www.kimi.com/code/docs/kimi-cli/guides/getting-started.html
Qwen https://qwen.ai/qwencode
Qoder https://docs.qoder.com/cli/quick-start
Pi https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent, and acp adatper: https://github.com/svkozak/pi-acp

Once an agent is installed, start MindFS and interact with it through the browser.

Install

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/a9gent/mindfs/main/scripts/install.sh | bash

Custom install path:

curl -fsSL https://raw.githubusercontent.com/a9gent/mindfs/main/scripts/install.sh | bash -s -- --prefix your/path

Windows (PowerShell)

irm https://raw.githubusercontent.com/a9gent/mindfs/main/scripts/install.ps1 | iex

The install script auto-detects your OS and architecture, reads the latest version from the first line of release-notes.md, then downloads the matching binary from GitHub Releases. release-notes.md keeps release history with the newest entry at the top; make release TAG=v1.2.3 commits and pushes it when changed, then uses only the top entry as the GitHub release notes.

Build from source (requires Go 1.22+, Node.js 20+)

git clone https://github.com/a9gent/mindfs.git
cd mindfs
make build      # output: ./mindfs

Run

mindfs                        # manage current directory
mindfs /path/to/your/project  # manage a specific directory
mindfs -addr :9000 /path/to/your/project  # custom port

Open http://localhost:7331 in your browser.

HTTPS (TLS)

Enable HTTPS with a self-signed certificate (auto-generated and reused across restarts):

mindfs -tls
mindfs -tls -addr :9000 /path/to/your/project

Open https://localhost:7331 in your browser. The auto-generated certificate includes SANs for localhost, 127.0.0.1, ::1, and all non-loopback interface IPs, so LAN clients can connect without certificate name mismatches. Certificates are stored under the user config directory (e.g., ~/.config/mindfs/ on Linux).

Use custom certificate and key files:

mindfs -tls -cert /path/to/cert.pem -key /path/to/key.pem

MindFS automatically detects the availability of installed agents. This usually takes about one minute.

Enable Remote Access (Optional)

  1. Open MindFS in local mode and click the bind button in the bottom-left corner.
  2. Log in to a9gent.com and confirm the binding.
  3. Open your node — it is now accessible from any device.

CLI Reference

mindfs [flags] [root]

Flags:
  -addr string   Listen address (default "127.0.0.1:7331")
  -no-relayer    Disable relay integration
  -remove        Unregister a managed directory from a running server
  -tls           Enable HTTPS (auto-generates self-signed cert if -cert/-key not provided)
  -cert string   TLS certificate file (PEM); requires -tls
  -key string    TLS private key file (PEM); requires -tls

Contributing

Pull requests are welcome. For larger changes, please open an issue first to discuss the approach.


License

AGPL v3

Friend Links

Linux.do

About

Access your personal AI agents and workstation data anywhere, anytime through MindFS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 53.5%
  • Go 38.9%
  • Java 4.8%
  • CSS 0.8%
  • JavaScript 0.6%
  • Shell 0.5%
  • Other 0.9%