Synchronization via Terminal

Use the command-line interface (CLI) of Sync-in to configure and trigger synchronizations between your local files and remote servers. This interface also allows you to manage multiple servers, define custom sync paths, and automate your transfer workflows.

An ideal solution for advanced users, scripting, or environments without a graphical interface.

Use Cases

• 🧱 Work in headless environments, such as remote servers or containers.
• ⏰ Schedule automatic synchronizations using CRON tasks or a system scheduler.
• 🔁 Automate your business workflows by integrating the CLI into processing or backup scripts.
• 🧪 Test syncs in simulation mode, using the --report and --debug options to identify changes without applying them or to troubleshoot.
• 🌐 Manage multiple servers from a single workstation, centralizing your connections in one tool.
• 🛠️ Deploy predefined configurations, for automated installations across multiple machines or environments.

Access Requirements

To use the CLI, the following conditions must be met:

• You must have the desktop access permission enabled.
• You must have the sync permission enabled.
• Node.js 22.x must be installed on the system.
• You must download the CLI binary from your Account or the Downloads page.

Quickstart

1. Add a server

./sync-in-cli servers add \
  --name <MY_SERVER> \
  --url https://<YOUR_DOMAIN> \
  --login <YOUR_LOGIN> \
  --password <YOUR_PASSWORD>

2. Add a sync path

./sync-in-cli paths add \
  --server <MY_SERVER> \
  --localPath </local/path/to/files> \
  --remotePath <personal|spaces|shares/...> \
  --name <SYNC_NAME> \
  --mode <both|upload|download> \
  --diffMode <fast|secure> \
  --conflictMode <recent|local|remote>

3. Launch synchronization

./sync-in-cli run \
  --server <MY_SERVER> \
  --path <PATH_NAME>

Management

Once the CLI is configured and registered with the server, it has access to your account.
Connection details can be viewed in the Clients menu of your account.

You can revoke CLI access at any time, regardless of the workstation used for configuration.

From the same menu, you can also update the sync configuration of CLI-managed paths.
Changes are applied on the next sync launch.

Security

After a certain period, you may be asked to re-authenticate to securely renew access to your account.

To perform this operation, see the re-authentication command.

Notes

note

Unlike the desktop app, files deleted locally (on the workstation) are not moved to the trash.

Commands

Command	Description
--help	Displays general help
--version	Shows the CLI version
run	Triggers syncs (see options below)
servers	Manages registered servers
paths	Manages sync paths

run Command

run – Start a synchronization

Manually launches a sync from the command line.
You can sync all configured paths or target specific servers/paths.
If --server or --path are not specified, all folders will be selected for synchronization.

Option	Alias	Description	Required
--report	-r	Read-only mode (dry-run), shows differences without applying them	❌
--debug	-d	Enables detailed logs for debugging	❌
--async	-a	Runs syncs in parallel	❌
--server	-s	ID or name of the server to sync	❌
--path	-p	ID(s) or name(s) of paths to sync (requires --server)	❌

servers Commands

Sub-command	Alias	Description
list	ls	List all registered servers
add	mk	Add a new server
remove	rm	Remove a registered server
auth	touch	Re-authenticate (refresh access token)

add (alias: mk)

Adds and registers a remote server for use with the CLI.

Option	Alias	Description	Required
--name	-n	Custom name for identifying the server	✅
--url	--web	Server URL (e.g., https://your-instance.com)	✅
--login	-u	User login or email	✅
--password	-p	User password	✅

remove (alias: rm)

Removes a registered server.

Option	Alias	Description	Required
--server	-s	ID or name of the server	✅

auth (alias: touch)

Refreshes the access token for a registered server.

Option	Alias	Description	Required
--server	-s	ID or name of the server	✅
--login	-u	User login or email	✅
--password	-p	User password	✅

paths Commands

Sub-command	Alias	Description
list	ls	List sync paths per server
add	mk	Add a new local/remote sync path
set	vi	Edit sync options for an existing path
remove	rm	Remove an existing sync path
update	up	Refresh paths from the server
flush	reset	Clear previous snapshots of a sync path

add (alias: mk)

Adds a new sync path (local/remote).

Option	Alias	Description	Required	Values	Default
--server	-s	Server ID or name	✅	—	—
--localPath	-l	Path to local file or folder	✅	—	—
--remotePath	-r	Remote path (spaces, personal, or shares)	✅	—	—
--name	-n	Custom sync name	❌	—	—
--mode	-m	Sync mode	✅	download, upload, both	—
--diffMode	-d	Difference detection mode	❌	fast, secure	fast
--conflictMode	-c	Conflict resolution strategy (if --mode both)	❌	recent, local, remote	recent

set (alias: vi)

Modifies sync options for an existing path.

Option	Alias	Description	Required	Values
--server	-s	Server ID or name	✅	—
--path	-p	Path ID or name	✅	—
--name	-n	New sync name	❌	—
--mode	-m	Sync mode	❌	download, upload, both
--diffMode	-d	Difference detection mode	❌	fast, secure
--conflictMode	-c	Conflict resolution strategy (if mode is both)	❌	recent, local, remote

remove (alias: rm)

Deletes an existing sync path.

Option	Alias	Description	Required
--server	-s	Server ID or name	✅
--path	-p	Path ID or name	✅

update (alias: up)

Refreshes all configured paths on a server.

Option	Alias	Description	Required
--server	-s	Server ID or name	✅

flush (alias: reset)

Clears the snapshots (previous states) of a path.

Option	Alias	Description	Required
--server	-s	Server ID or name	✅
--path	-p	Path ID or name	✅