### 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 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 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 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"

```

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

### 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
}

```

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

### 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

```

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

### 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.

```

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

### Start sync when connected to a specific Wi-Fi network (Android only)

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

Uses WiFiConnect trigger with condition SSIDIdentifierIs "MyHomeNetwork" and StartSync action to start syncing on connecting to a specific network.

```plaintext
Event trigger: WiFiConnect
Condition: SSIDIdentifierIs "MyHomeNetwork"
Action: StartSync
Use case: Automatically start syncing when the device connects to a specific Wi-Fi network (e.g., home or office).

```

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

### Add tacitdynamics Scoop bucket

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

Adds the tacitdynamics Scoop bucket, the first step to installing foldersync-cli via Scoop on Windows.

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

```

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

### foldersync-cli sync

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

Starts synchronization for a folder pair. Optionally specify a folder pair by ID or name.

```APIDOC
## foldersync-cli sync

### Description
Starts synchronization for a folder pair. Optionally specify a folder pair by ID or name.

### Usage
`foldersync-cli sync [id=ID] [name=NAME]`

### Arguments
- `id` (string) - Optional - Folder pair ID
- `name` (string) - Optional - Folder pair name

### Examples
```
foldersync-cli sync
foldersync-cli sync name=MyFolderPair
```
```

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

### Start sync when connected to a specific Wi-Fi network (Android only)

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

Automatically start syncing when the device connects to a specific Wi-Fi network (e.g., home or office).

```text
Event trigger: WiFiConnect
Condition: SSIDIdentifierIs "MyHomeNetwork"
Action: StartSync
Use case: Automatically start syncing when the device connects to a specific Wi-Fi network (e.g., home or office).
```

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

### Show foldersync-cli usage

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

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

```bash
foldersync-cli

```

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

### 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.

```

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

### Add custom root CA to FolderSync Desktop trust store using keytool

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

Use this command to import a custom root CA certificate into FolderSync Desktop's application-specific trust store. This is necessary when SSL errors like 'unable to find valid certification path to requested target' occur on networks with SSL inspection. Replace 'customrootca.der' with your certificate file and '<path to FolderSync Desktop cacerts>' with the actual cacerts file path.

```bash
keytool -import -trustcacerts -alias customrootca -file customrootca.der -keystore <path to FolderSync Desktop cacerts>

```

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

### foldersync-cli list

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

Lists folder pairs and their state.

```APIDOC
## foldersync-cli list

### Description
Lists folder pairs and their state.

### Usage
`foldersync-cli list`

### Examples
```
foldersync-cli list
```
```

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

### foldersync-cli command syntax

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

General syntax for the foldersync-cli command. Use --version to print version information, and specify a command with optional arguments.

```bash
foldersync-cli [--version] <command> [args...]

```

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

### Account path with placeholders

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

The path field on account allows one or more placeholders in double curly brackets. The end user is asked to provide these values during the import wizard.

```text
`/webdav/{{User ID}}/some/path{{Company Name}}/`
```

```text
`{{ExternalSdCard}}/some/path`
```

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

### Manual Intent: Sync All Folderpairs

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

Manual intent to sync all enabled folderpairs. Use this only if you need programmatic control or are integrating from other automation tools. The package can be either the full or lite version of FolderSync.

```text
Action: com.tacit.foldersync.action.SYNC_ALL
Package: dk.tacit.android.foldersync.full (or .lite)
Target: Broadcast Receiver
```

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

### Retry sync if sync fails

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

Uses Schedule trigger with condition FolderPairPreviousSyncState "Failed" and StartSync action to retry failed syncs at scheduled times.

```plaintext
Event trigger: Schedule
Condition: FolderPairPreviousSyncState "Failed"
Action: StartSync
Use case: If a sync fails due to a temporary issue (such as unstable network) retry at specific time(s).

```

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

### Steps to add a shared folder to your Google Drive

Source: https://foldersync.io/docs/faq/drive?q=

Use these steps in the Google Drive browser interface to add a shared folder to your Drive so FolderSync can sync to it. The steps involve opening the 'Shared with me' section, selecting the folder, pressing 'Shift + Z', and choosing a location.

```text
1. Open the "Shared with me" section. 
2. Click a folder or files to be added to another location. (it will be highlighted) 
3. Press down "Shift + Z" 
4. Choose a location in a dialog box.
```

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

### foldersync-cli encrypt-file

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

Encrypts a file using a password and outputs the encrypted file to a directory.

```APIDOC
## foldersync-cli encrypt-file

### Description
Encrypts a file using a password and outputs the encrypted file to a directory.

### Usage
`foldersync-cli encrypt-file <input-path> <output-dir> <password>`

### Arguments
- `input-path` (string) - Required - Path to the input file
- `output-dir` (string) - Required - Directory where the encrypted file will be saved
- `password` (string) - Required - The password used for encryption

### Examples
```
foldersync-cli encrypt-file ./report.pdf ./out mySecret
```
```

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

### foldersync-cli sync-log

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

Shows the latest synchronization log for a folder pair. Optionally specify a folder pair by ID or name.

```APIDOC
## foldersync-cli sync-log

### Description
Shows the latest synchronization log for a folder pair. Optionally specify a folder pair by ID or name.

### Usage
`foldersync-cli sync-log [id=ID] [name=NAME]`

### Arguments
- `id` (string) - Optional - Folder pair ID
- `name` (string) - Optional - Folder pair name

### Examples
```
foldersync-cli sync-log
```
```

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

### foldersync-cli status

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

Shows the FolderSync Desktop status.

```APIDOC
## foldersync-cli status

### Description
Shows the FolderSync Desktop status.

### Usage
`foldersync-cli status`

### Examples
```
foldersync-cli status
```
```

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

### Manual Intent: Sync Specific Folderpair

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

Manual intent to sync a specific folderpair. Use this only if you need programmatic control or are integrating from other automation tools. The package can be either the full or lite version of FolderSync.

```text
Action: com.tacit.foldersync.action.SYNC
Extra: folderpair:<name>
Package: dk.tacit.android.foldersync.full (or .lite)
Target: Broadcast Receiver
```

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

### Retry sync if sync fails

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

If a sync fails due to a temporary issue (such as unstable network) retry at specific time(s).

```text
Event trigger: Schedule
Condition: FolderPairPreviousSyncState "Failed"
Action: StartSync
Use case: If a sync fails due to a temporary issue (such as unstable network) retry at specific time(s).
```

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

### foldersync-cli scheduled-sync

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

Enables or disables scheduled synchronization.

```APIDOC
## foldersync-cli scheduled-sync

### Description
Enables or disables scheduled synchronization.

### Usage
`foldersync-cli scheduled-sync <enable|disable>`

### Arguments
- `enable|disable` (string) - Required - Specify `enable` to turn on scheduled sync or `disable` to turn it off.

### Examples
```
foldersync-cli scheduled-sync disable
```
```

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

### Run System File Checker with sfc

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

Runs the System File Checker to scan and repair protected system files. Use after DISM to fix corrupted system files.

```powershell
sfc /scannow

```

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

### foldersync-cli encrypt-filename

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

Encrypts a filename using a password.

```APIDOC
## foldersync-cli encrypt-filename

### Description
Encrypts a filename using a password.

### Usage
`foldersync-cli encrypt-filename <name> <password>`

### Arguments
- `name` (string) - Required - The filename to encrypt
- `password` (string) - Required - The password used for encryption

### Examples
```
foldersync-cli encrypt-filename report.pdf mySecret
```
```

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

### Show reserved TCP port ranges with netsh

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

Lists TCP port ranges reserved by Windows, including those held by winnat. Run this to confirm whether port 49734 is reserved even though it appears unused.

```powershell
netsh int ipv4 show excludedportrange protocol=tcp

```

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

### Trigger a webhook after sync completion

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

Uses SyncComplete trigger with condition FolderPairPreviousSyncOlderThan 24 hours and WebHook action to notify a system about sync completion details.

```plaintext
Event trigger: SyncComplete
Condition: FolderPairPreviousSyncOlderThan 24 hours
Action: WebHook (send sync details)
Use case: Notify a system via a webhook about the sync completion, including information such as the number of transferred files or sync duration.

```

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

### Convert .crt certificate to DER format using openssl

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

Use this command to convert a .crt certificate (PEM format) to DER format, which is required for the keytool import command. Replace '<filename.pem>' and '<filename.der>' with your actual file names.

```bash
openssl x509 -in <filename.pem> -inform pem -out <filename.der> -outform der

```

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

### foldersync-cli sync-status

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

Shows the active synchronization status.

```APIDOC
## foldersync-cli sync-status

### Description
Shows the active synchronization status.

### Usage
`foldersync-cli sync-status`

### Examples
```
foldersync-cli sync-status
```
```

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

### foldersync-cli decrypt-file

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

Decrypts an encrypted file using a password and outputs the decrypted file to a directory.

```APIDOC
## foldersync-cli decrypt-file

### Description
Decrypts an encrypted file using a password and outputs the decrypted file to a directory.

### Usage
`foldersync-cli decrypt-file <input-path> <output-dir> <password>`

### Arguments
- `input-path` (string) - Required - Path to the encrypted input file
- `output-dir` (string) - Required - Directory where the decrypted file will be saved
- `password` (string) - Required - The password used for decryption

### Examples
```
foldersync-cli decrypt-file ./out/report.pdf.fscrypt ./decrypted mySecret
```
```

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

### Set MESA_EXTENSION_OVERRIDE to work around graphics crash

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

Workaround for a graphics driver crash on Raspberry Pi and/or Linux Arm64 when using the mesa OpenGL driver. Set this environment variable before launching the application.

```bash
export MESA_EXTENSION_OVERRIDE="-GL_ARB_invalidate_subdata"

```

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

### Repair component store with DISM

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

Repairs the Windows component store image. Run this before sfc /scannow when system file corruption is suspected.

```powershell
DISM.exe /Online /Cleanup-image /Restorehealth

```

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

### Tasker Task: Smart Photo Backup

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

Tasker task for the 'Home Photo Backup' profile. It waits 5 minutes, checks if the device is connected to the home Wi-Fi, triggers FolderSync to sync the Camera Backup folderpair, and optionally notifies. The Wi-Fi condition uses the %WIFI variable and the SSID placeholder.

```text
1. Wait: 5 minutes (optional delay)
2. If: %WIFI ~ *YourHomeSSID*
3.   Plugin → FolderSync
     Configuration: Sync → Camera Backup
4. End If
5. Notify: "FolderSync backup started" (optional)
```

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

### Trigger a webhook after sync completion

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

Notify a system via a webhook about the sync completion, including information such as the number of transferred files or sync duration.

```text
Event trigger: SyncComplete
Condition: FolderPairPreviousSyncOlderThan 24 hours
Action: WebHook (send sync details)
Use case: Notify a system via a webhook about the sync completion, including information such as the number of transferred files or sync duration.
```

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

### Stop sync if too many files are deleted

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

Stop syncing if over 100 files are scheduled to be deleted to prevent accidental data loss.

```text
Event trigger: SyncAnalysisComplete
Condition: SyncDeletedFilesMoreThan 100
Action: StopCurrentSync
Use case: Stop syncing if over 100 files are scheduled to be deleted to prevent accidental data loss.
```

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

### Stop sync if too many files are deleted

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

Uses SyncAnalysisComplete trigger with condition SyncDeletedFilesMoreThan 100 and StopCurrentSync action to prevent accidental data loss.

```plaintext
Event trigger: SyncAnalysisComplete
Condition: SyncDeletedFilesMoreThan 100
Action: StopCurrentSync
Use case: Stop syncing if over 100 files are scheduled to be deleted to prevent accidental data loss.

```

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

### Free reserved port 49734 and exclude it from winnat

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

Restarts the winnat service and adds port 49734 to the excluded range so it is no longer reserved. May cause temporary loss of internet connectivity until reboot.

```powershell
net stop winnat
net start winnat
netsh int ipv4 add excludedportrange protocol=tcp startport=49734 numberofports=1

```

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

### foldersync-cli sync-stop

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

Stops an ongoing synchronization for a folder pair. Optionally specify a folder pair by ID or name.

```APIDOC
## foldersync-cli sync-stop

### Description
Stops an ongoing synchronization for a folder pair. Optionally specify a folder pair by ID or name.

### Usage
`foldersync-cli sync-stop [id=ID] [name=NAME]`

### Arguments
- `id` (string) - Optional - Folder pair ID
- `name` (string) - Optional - Folder pair name

### Examples
```
foldersync-cli sync-stop id=3
```
```

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

### foldersync-cli decrypt-filename

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

Decrypts an encrypted filename using a password.

```APIDOC
## foldersync-cli decrypt-filename

### Description
Decrypts an encrypted filename using a password.

### Usage
`foldersync-cli decrypt-filename <name> <password>`

### Arguments
- `name` (string) - Required - The encrypted filename to decrypt
- `password` (string) - Required - The password used for decryption

### Examples
```
foldersync-cli decrypt-filename report.pdf.fscrypt mySecret
```
```

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

### Cancel sync if file transfer size exceeds limit

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

Uses SyncAnalysisComplete trigger with condition SyncTransferSizeMoreThan 1 GB and CancelSync action to prevent large sync operations.

```plaintext
Event trigger: SyncAnalysisComplete
Condition: SyncTransferSizeMoreThan 1 GB
Action: CancelSync
Use case: Prevent large sync operations by canceling any sync that transfers over 1 GB of data.

```

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

### Cancel sync if too many files are transferred

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

Cancel the sync if the analysis shows that over 500 files are queued for transfer.

```text
Event trigger: SyncAnalysisComplete
Condition: SyncTransferFilesMoreThan 500
Action: CancelSync
Use case: Cancel the sync if the analysis shows that over 500 files are queued for transfer.
```

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

### Cancel sync if too many files are transferred

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

Uses SyncAnalysisComplete trigger with condition SyncTransferFilesMoreThan 500 and CancelSync action to cancel sync when many files are queued.

```plaintext
Event trigger: SyncAnalysisComplete
Condition: SyncTransferFilesMoreThan 500
Action: CancelSync
Use case: Cancel the sync if the analysis shows that over 500 files are queued for transfer.

```

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

### Disable scheduled sync when Wi-Fi disconnects (Android only)

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

Uses WiFiDisconnect trigger with DisableSchedule action to disable scheduled syncing when Wi-Fi is lost, saving mobile data.

```plaintext
Event trigger: WiFiDisconnect
Action: DisableSchedule
Use case: Disable scheduled syncing when the device loses a Wi-Fi connection to save mobile data.

```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.