I forked this because I needed to change where the config files were located and wanted to add a nix flake. The upstream now supports using XDG_CONFIG_HOME, so a flake could just build from the original source.
Stc is a command line tool for Syncthing. It can be used to quickly check status of Syncthing from a terminal / command line without need of a Web Browser. For example on a remote machine over ssh, without port forwarding or if you have large number of machines to query. Also run from a script, crontab, scheduled task, etc.
$ stc
Host Uptime Version
homenas 2 weeks v1.19.0
Folder Paused State Global Local
pics false idle 37 GB 37 GB
docs false idle 4 GB 4 GB
backups false idle 86 GB 86 GB
Device Paused Conn Sync% Download Upload
office false true 100.0% 11 kB 11 kB
laptop false false 83.2% 0 B 0 B
jakob-home false true 100.0% 89 MB 447 kB
backup-nas false true 100.0% 6.3 kB 7.0 kB
*homenas false true 100.0% 0 B 0 B
$ stc [flags] [commands]Run stc as the same user as Syncthing. It will look for config.xml in
the XDG_CONFIG_HOME directory, or specify it with --configfile=/path...
Stc takes --apikey=xxx and --target=http://... flags to connect to a
Syncthing service. The API Key can be obtained from the Syncthing Web UI
(Settings:General tab) or from config.xml file.
API Key can also be specified by APIKEY environmental variable.
If the config is not located in the same user's XDG config directory,
(eg ~/.config/syncthing/config.xml), specify it with the --configfile flag.
If you use TLS/SSL/https without valid certificate you can use the flag
--ignore_cert_errors to suppress the errors. This is considered very insecure.
--apikey - Syncthing API Key
--target - URL of the Syncthing target
--configfile - Path of Syncthing config.xml, if specified stc
will try to find apikey and target from it
--ignore_cert_errors - Ignore cert errors while using https/SSL/TLS
log - print syncthing 'recent' log
restart - restart syncthing daemon
shutdown - shutdown syncthing daemon
errors - print errors visible in web UI
clear_errors - clear errors in the web UI
post_error - posts a custom error message in the web UI
folder_errors - prints folder errors from scan or pull
id - print ID of this node
reset_db - reset the database / file index
rescan - rescan a folder or 'all'
override - override remote changed for a send-only folder (OoSync)
revert - revert local changes for a receive-only folder (LocAdds)
See Releases
- Copyright 2022 Google LLC
- Licensed under Apache 2.0
- This is not an official Google product