Warning
Synctui is under active development. Everything that works, should be correct, but it's not heavily tested yet.
Note
- Not affiliated with the Syncthing Foundation.
- Contributions are welcome!
Synctui lets you control Syncthing from your terminal — no need to open a browser. Perfect for headless setups like servers or Raspberry Pis. Skip the port forwarding and get syncing.
It already supports most essential features, so you can manage devices and folders pretty comfortably. That said, don’t uninstall the Syncthing GUI just yet — advanced features are still on the roadmap.
- Install Rust and Cargo (if you haven't already):
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Install Synctui
cargo install --git https://github.com/hertelukas/synctui
- Configure Synctui:
Create a config.toml in your system's default config directory. On Linux, for example:
~/.config/synctui/config.toml
With this content:
api-key="your-api-key"
To find your API key (on Linux):
cat ~/.config/syncthing/config.xml | grep apikey
- Run the app:
synctui
- Accept incoming devices
- Accept incoming folders
- Create and share new folders
- Show device ID as a QR code
- Modify/delete folders
- Modify/delete devices
- Ignore folders/devices
- Live sync status & updates (WIP)
- Support for encrypted endpoints
- Add new devices (currently, they have to add you)