Setup guides, feature documentation, technical references and measured test reports for AeroFTP, the open-source desktop file manager with a CLI and MCP server.
The published site is docs.aeroftp.app. This repository contains its Markdown pages, Vue components, theme and static assets. AeroFTP's application source and releases live in axpdev-lab/aeroftp.
| Section | What you will find |
|---|---|
| Getting started | Installation on Linux, Windows and macOS; first connection and interface guide |
| Protocols | FTP/FTPS, SFTP, WebDAV, S3-compatible storage, Azure Blob, Backblaze B2 and checksum behavior |
| Provider setup guides | Cloud sign-in, endpoints, native clients, local gateways, plan snapshots and provider-specific limits |
| Proton Drive | Native API sign-in and encrypted sessions, optional official CLI mode, bulk transfers and headless use |
| Features | AeroCloud, AeroSync, AeroRsync, delta transfers, mounts, AeroFile, AeroPlayer, archives and file tools |
| Encryption | AeroVault, AeroCrypt, credential storage, wrapper stacks and error correction |
| AeroAgent | Built-in AI file operations, approval behavior and agent orchestration |
| CLI | Installation, saved profiles, commands, scripting, machine output and exit codes |
| MCP | Connecting AI tools to AeroFTP through the bundled MCP server |
| Profile bridges | rclone import/export and native Proton sessions; also WinSCP, FileZilla and rclone crypt |
| Architecture | Transfer DAG, scheduling, resource limits and the fixed-pipe model |
| Security | Privacy, audits, supply chain, AI boundaries, TOTP and vulnerability reporting |
| Test reports | Provider matrices, Docker integration tests, comparative benchmarks and community results |
| Advanced reference | Provider details, AI providers, plugins, hosting integration and the AeroVault Rust crate |
Provider counts, command inventories and benchmark results evolve with the application. Consult the relevant reference or dated report for its version, scope and limitations.
Use Node.js 24, matching the deployment workflow, and npm. From this repository:
npm ci
npm run docs:devVitePress prints the local development address, normally http://localhost:5173.
Build the static site and preview the result:
npm run docs:build
npm run docs:previewThe output is written to .vitepress/dist/. Dependencies, build output, the VitePress cache and _dev/ scratch files are ignored by Git.
docs.aeroftp.app/
├── getting-started/ Installation, quick start and interface
├── protocols/ Transport and storage references
├── providers/ Provider setup guides
├── features/ Built-in apps, sync, agents and bridges
├── cli/ CLI reference, examples and scripting
├── mcp/ MCP setup and tool reference
├── architecture/ Transfer-engine architecture
├── security/ Security, privacy and audit documentation
├── advanced/ Provider, plugin and integration references
├── test-reports/ Dated tests, matrices and comparisons
├── contributing/ Application build and architecture guides
├── tools/ Test harnesses and supporting scripts
├── public/ Images, icons and downloadable evidence
├── .vitepress/ Site config, sidebar, Vue components and theme data
└── .github/workflows/ Build and GitHub Pages deployment
Navigation is defined in .vitepress/config.ts. Provider plan cards share data from providerPlans.ts. The feature overview reads its groups from the sidebar and its descriptions from page frontmatter.
- Create a branch, or fork the repository for an external contribution.
- Edit the relevant page and update shared data or navigation when needed.
- Run
npm run docs:build, preview the affected pages and check their links. - Open a pull request describing the change and how it was verified.
For benchmark contributions, include the tested versions, commands, payload, all counted runs and integrity checks. See the test methodology. Report application bugs and feature requests in the AeroFTP repository; documentation corrections belong here.
The Deploy Documentation workflow installs dependencies with npm ci, builds with VitePress and deploys .vitepress/dist/ to GitHub Pages at docs.aeroftp.app. It runs on pushes to main and can also be started manually through GitHub Actions. Merging a documentation PR into main triggers publication.