syncthing-cli initial release

2 minute read Published:

syncthing-cli client initial release

syncthing-cli is a command-line client for Syncthing written in Go.

You can download it on the releases page.

Run it for the first time and it will create a config file for you in $XDG_CONFIG_HOME/syncthing-cli/config.ini:

; Specify the API key below
api-key = 
address = 127.0.0.1:8384

You need to add api-key there which you can get from the web GUI or the Syncthing config file in $XDG_CONFIG_HOME/syncthing/config.xml.

After that you’re ready to go. Use help for info.

$ syncthing-cli help
usage: syncthing-cli [<flags>] <command> [<args> ...]

CLI client for Syncthing

Flags:
      --help             Show context-sensitive help (also try --help-long and --help-man).
      --version          Show application version.
  -c, --config=/home/dt/.config/syncthing-cli/config.ini
                         Location of the config file.
  -a, --address=ADDRESS  Address of the Syncthing daemon.
  -k, --api-key=API-KEY  API key to access the REST API of the Syncthing daemon.

Commands:
  help [<command>...]
    Show help.

  version
    Show the current Syncthing version information.

  config
    Show the current configuration.

  device list
    List devices.

  device stats
    Show device stats.

  device add [<flags>] <ID> [<name>]
    Add a new device.

  device remove <ID>
    Remove a device.

  folder list
    List folders.

  folder stats
    Show folder stats.

  folder add [<flags>] <label> <path>
    Add a new folder.

  folder remove <ID>
    Remove a folder.

  restart
    Restart the Syncthing daemon.

  shutdown
    Shutdown the Syncthing daemon.

  pause [<devices>...]
    Pause the given devices or all devices.

  resume [<devices>...]
    Resume the given devices or all devices.