filefive/README.md

SFTP/FTP/Amazon S3 client and dual-panel file manager for macOS and Linux

<p align="center">
    <img src="https://github.com/miroshnikov/filefive/blob/main/frontend/src/assets/logo.svg" width="64" alt="FileFive" />
</p>


# FileFive: SFTP/FTP/AWS S3 GUI client and dual-panel file manager for macOS and Linux
FileFive is a free open-source SFTP/FTP/Amazon S3 client and file manager with intuitive and modern dual-panel user interface, available on Mac, and Linux. 

It has a unique set of features and may be a free alternative to `FileZilla Pro`, `Transmit`, `ForkLift` and `Cyberduck`.

FileFive is also a visual, no-code and easy-to-use backup and CI/CD tool for developers and system administrators with user-friendly UI interface, offering similar functionality to `rsync`, `rclone` and `sshfs`.

<p align="center">
    <img src="https://github.com/miroshnikov/filefive/blob/main/docs/screenshots/screenshot-1.png" alt="FileFive" />
</p>
<p align="center">
  <details>
    <summary>More screenshots</summary>
    <img src="https://github.com/miroshnikov/filefive/blob/main/docs/screenshots/screenshot-2.png" alt="FileFive"/>
    <img src="https://github.com/miroshnikov/filefive/blob/main/docs/screenshots/screenshot-3.png" alt="FileFive"/>
    <img src="https://github.com/miroshnikov/filefive/blob/main/docs/screenshots/screenshot-4.png" alt="FileFive"/>
  </details>
</p>

## Installation
```shell
npm install -g filefive
```

## Usage
Run `f5` and FileFive will be opened in the default browser. Press <kbd>ctrl</kbd> + <kbd>c</kbd> to quit the program.
```
> f5 --help
Usage: F5 [options]

SFTP/FTP/S3 client, dual-panel file manager in the browser

Options:
  -V, --version        output the version number
  -p, --port <number>  port number (default: "3113")
  --log                prints the log information
  -h, --help           display help
```

## Features
- **Cross-platform**, runs on MacOS, Linux and any *nix with Node.js
- **Upload, download, and manage files** on cloud servers using
  - SSH File Transfer Protocol (**SFTP**)
  - File Transfer Protocol (**FTP**)
  - Amazon Simple Storage Service (**Amazon S3**)
- Powerful, intuitive and minimalistic UI, that **mimics the look and feel of VSCode Explorer view**, including VS Code file icon themes
- **Search/filter** files using wildcards, **JavaScript Regular Expressions** and Git status
- **Synchronized browsing**
- **Upload/download/copy files and folders preserving relative paths**, similar to `cp --parents`, `rsync -R` or MacOS `ditto` commands. Any necessary parent directories in the destination will be created to replicate the path of the source files. It allows **synchronization files in nested folders in one click**
- **Remote file editing**
- **Files' Git statuses** (uses your machine's Git installation)
- Connections/servers are **plain files stored on your filesystem**, no need to export/import
- **Easy to copy and backup connections and settings** in `~/.f5` folder, e.g. by putting them into a Git repo
- **Drag & drop**, **copy & paste** files support
- Use browser **tabs** to browse more than one server or transfer files simultaneously
- Utilize the **built-in browser password manager** to store passwords
- **Open files and folders** in default app or **Visual Studio Code**
- **Theming**: System preference, Light, Dark; a different color theme per connection; the most popular file and folder icon themes from VS Code
- Search On Type

## Feedbacks
To support its development, [star FileFive on GitHub](https://github.com/miroshnikov/filefive/stargazers)!

[Feedback, suggestion, improvements](https://github.com/miroshnikov/filefive/discussions) or [bugs](https://github.com/miroshnikov/filefive/issues) are welcome.

## License
[GPL-3.0 License](LICENSE)