Skip to content

Command Line Interface (CLI)

Control FolderSync Desktop directly from your terminal with the foldersync-cli tool. Start and stop synchronization tasks, check status, and automate workflows—all from the command line.

Prerequisites

FolderSync Desktop must be installed and running on your system for the CLI tool to function properly.

Installation

Choose your preferred installation method based on your operating system:

If you don't have Homebrew installed, visit the official Homebrew website for installation instructions.

brew install --cask tacitdynamics/tap/foldersync-cli --no-quarantine

About the --no-quarantine flag

This flag prevents macOS from quarantining the application, allowing it to run without additional security prompts.

Using Homebrew

Homebrew also works on Linux! If you don't have it installed, follow the official Homebrew installation guide.

brew tap tacitdynamics/tap
brew install foldersync-cli

New to Scoop? Check out the Scoop Quickstart guide to get started.

Step 1: Add the bucket 

scoop bucket add tacitdynamics https://github.com/tacitdynamics/scoop-bucket.git

Step 2: Install the app 

scoop install foldersync-cli

Direct Download

Download pre-compiled binaries for any platform from our GitHub Releases page.

Installation steps:

  1. Download the appropriate version for your operating system
  2. Extract the archive to a location of your choice
  3. Add the binary to your system's PATH environment variable

Manual PATH Configuration Required

When installing manually, you'll need to add the binary location to your system's PATH to use the foldersync-cli command from any directory.

Next Steps

After installation, you can verify it's working by running:

foldersync-cli --version

For detailed usage instructions and available commands, run:

foldersync-cli