FolderSync

https://foldersync.io/docs
Admin
FolderSync is a synchronization application that syncs files and folders between local devices,...
Tokens:63,045
Snippets:647
Trust Score:8
Update:1 month ago
Show doc for...
Tokens:
Raw
### foldersync-cli example commands

Source: https://foldersync.io/docs/help/cli

Example commands for the foldersync-cli tool. They cover starting and stopping sync, viewing logs, disabling scheduled sync, listing folder pairs, checking status, and encrypting/decrypting filenames and files.

```bash
foldersync-cli sync
foldersync-cli sync name=MyFolderPair
foldersync-cli sync-stop id=3
foldersync-cli sync-log
foldersync-cli scheduled-sync disable
foldersync-cli list
foldersync-cli status
foldersync-cli encrypt-filename report.pdf mySecret
foldersync-cli decrypt-filename report.pdf.fscrypt mySecret
foldersync-cli encrypt-file ./report.pdf ./out mySecret
foldersync-cli decrypt-file ./out/report.pdf.fscrypt ./decrypted mySecret

```

--------------------------------

### Install missing dependencies with apt-get -f install

Source: https://foldersync.io/docs/faq/linux

Installs missing dependencies when the Linux app fails to start or crashes after installing via deb files. Run this command to fix dependency issues.

```bash
sudo apt-get -f install

```

--------------------------------

### Install foldersync-cli with Homebrew (Linux)

Source: https://foldersync.io/docs/help/cli

Installs the CLI on Linux using Homebrew. Requires Homebrew to be installed first.

```bash
brew tap tacitdynamics/tap
brew install foldersync-cli

```

--------------------------------

### Install foldersync-cli with Scoop

Source: https://foldersync.io/docs/help/cli

Installs foldersync-cli using Scoop after adding the bucket. This is the second step of the Scoop installation.

```bash
scoop install foldersync-cli

```

--------------------------------

### Exported JSON example

Source: https://foldersync.io/docs/mdm/export

Sample JSON content showing configuration structure.

```json
{
    "config": {
        "description": "Optional description goes here.",
        "updateType": "UpdateExisting"
    }
}
```

--------------------------------

### Install MSIX package with Add-AppxPackage

Source: https://foldersync.io/docs/faq/windows

Installs an MSIX package directly via PowerShell, bypassing the graphical App Installer. Provides explicit error details if installation fails.

```powershell
Add-AppxPackage -Path "C:\Path\To\YourApp.msix"

```

--------------------------------

### Check foldersync-cli version

Source: https://foldersync.io/docs/help/cli

Verifies the CLI installation by printing version information.

```bash
foldersync-cli --version

```

--------------------------------

### Install foldersync-cli with Homebrew (macOS)

Source: https://foldersync.io/docs/help/cli

Installs the CLI on macOS using Homebrew. The --no-quarantine flag prevents macOS from quarantining the application, allowing it to run without additional security prompts.

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

```

--------------------------------

### POST webhook JSON body example

Source: https://foldersync.io/docs/help/v2/webhooks?q=

Example of the JSON body sent to a POST webhook. The parameters folderPairName and syncStatus are automatically added to all POST content. The fields checkedFiles, transferredFiles, and deletedFiles are not available in the Starting sync webhook.

```json
{
    "folderPairName": "Backup sync",
    "syncStatus": "SyncOK",
    "someName": "someValue",
    "checkedFiles": 2, // not available in Starting sync webhook
    "transferredFiles": 5, // not available in Starting sync webhook
    "deletedFiles": 0 // not available in Starting sync webhook
}

```

--------------------------------

### Show foldersync-cli usage

Source: https://foldersync.io/docs/help/cli

Displays detailed usage instructions and available commands for foldersync-cli.

```bash
foldersync-cli

```

--------------------------------

### Start sync automatically at a specific time

Source: https://foldersync.io/docs/help/automationexamples

Uses a Schedule trigger with the StartSync action to automatically start a folderPair synchronization every morning at 8:00 AM.

```plaintext
Event trigger: Schedule
Action: StartSync
Use case: Automatically start a folderPair synchronization every morning at 8:00 AM.

```

--------------------------------

### Create backup after folder pair sync completes

Source: https://foldersync.io/docs/help/automationexamples

Uses SyncComplete trigger with condition FolderPairPreviousSyncState "Success" and CreateBackup action to create a database backup after successful sync.

```plaintext
Event trigger: SyncComplete
Condition: FolderPairPreviousSyncState "Success"
Action: CreateBackup
Use case: Automatically create a backup of the app’s database after every successful sync of a specific folder pair.

```
Tokens:
Raw