Aller au contenu principal

Synchronisation via Terminal

Utilisez l’interface en ligne de commande (CLI) de Sync-in pour configurer et déclencher des synchronisations entre vos fichiers locaux et vos serveurs distants. Cette interface permet également de gérer plusieurs serveurs, de définir des chemins de synchronisation personnalisés, et d’automatiser vos workflows de transfert.

Une solution idéale pour les utilisateurs avancés, les scripts ou les environnements sans interface graphique.

OnlyOffice

Cas d’Usage

  • 🧱 Travailler dans un environnement sans interface graphique, comme un serveur distant ou un conteneur.
  • Planifier des synchronisations automatiques avec des tâches CRON ou un planificateur système.
  • 🔁 Automatiser vos workflows métiers, en intégrant le CLI dans vos scripts de traitement ou de sauvegarde.
  • 🧪 Tester vos synchronisations en mode simulation, avec les options --report et --debug pour identifier les changements sans les appliquer ou diagnostiquer les problèmes.
  • 🌐 Gérer plusieurs serveurs depuis un seul poste, en centralisant les connexions dans un même outil.
  • 🛠️ Déployer des configurations préétablies, pour des installations automatisées sur de nombreux postes ou environnements.

Conditions d’Accès

Pour utiliser le CLI, les conditions suivantes doivent être réunies :

  • Disposer de la permission d’accès depuis l'application de bureau
  • Disposer de la permission de synchronisation depuis l'application de bureau
  • Node.js 22.x installé sur le système.
  • Avoir téléchargé le binaire CLI depuis votre Compte ou depuis la page de Téléchargement

Démarrage rapide

1. Ajouter un serveur

./sync-in-cli servers add \
--name <MON_SERVEUR> \
--url https://<VOTRE_DOMAINE> \
--login <VOTRE_LOGIN> \
--password <VOTRE_MOT_DE_PASSE>

2. Ajouter un chemin à synchroniser

./sync-in-cli paths add \
--server <MON_SERVEUR> \
--localPath </chemin/local/vers/les/fichiers> \
--remotePath <personal|spaces|shares/...> \
--name <NOM_SYNC> \
--mode <both|upload|download> \
--diffMode <fast|secure> \
--conflictMode <recent|local|remote>

3. Lancer la synchronisation

./sync-in-cli run \
--server <MON_SERVEUR> \
--path <NOM_CHEMIN>

Gestion

Une fois le CLI configuré et enregistré auprès du serveur, il dispose d’un accès à votre compte.
Les informations liées à cette connexion sont consultables dans le menu Clients de votre compte.

L’accès du CLI peut être révoqué à tout moment, quel que soit le poste depuis lequel il a été configuré.

Depuis ce même menu, il est également possible de modifier la configuration des synchronisations des chemins gérés par le CLI.
Les changements sont appliqués lors du prochain lancement d’une synchronisation.

Sécurité

Après un certain délai, une nouvelle authentification peut être demandée afin de renouveler l’accès de manière sécurisée à votre compte.

Pour effectuer cette opération, voir la commande de ré-authentification.

Notes

remarque

Contrairement à l'application de bureau, les fichiers supprimés localement (sur le poste) ne sont pas déplacés dans la corbeille.

Commandes

CommandeDescription
--helpAffiche l’aide générale
--versionAffiche la version de l’outil
runLance les synchronisations (voir options ci-dessous)
serversGère les serveurs enregistrés
pathsGère les chemins de synchronisation

Commande run

run – Lancer une synchronisation

Permet de lancer une synchronisation manuelle depuis la ligne de commande. Possibilité d'exécuter tous les chemins configurés ou de cibler un serveur ou des chemins spécifiques. Si aucune les options server ou path ne sont pas spécifiés tous les dossiers sont sélectionnés pour la synchronisation.

OptionAliasDescriptionRequis
--report-rMode lecture seule (dry-run), affiche les différences sans les appliquer
--debug-dActive les logs détaillés pour le débogage
--async-aExécute les synchronisations en parallèle
--server-sID ou nom du serveur à synchroniser
--path-pID(s) ou nom(s) du ou des chemins à synchroniser (le serveur doit être spécifié)

Commandes servers

Sous-commandeAliasDescription
listlsLister les serveurs enregistrés
addmkAjouter un serveur distant
removermSupprimer un serveur enregistré
authtouchRé-authentifier un serveur (renouvellement de token)

add (alias : mk)

Ajoute un serveur distant et l'enregistre pour l'utiliser avec la CLI.

OptionAliasDescriptionRequis
--name-nNom personnalisé pour identifier le serveur
--url--webURL du serveur (ex : https://mon-instance.com)
--login-uIdentifiant ou adresse e-mail de l’utilisateur
--password-pMot de passe de l’utilisateur

remove (alias : rm)

Supprime un serveur enregistré.

OptionAliasDescriptionRequis
--server-sID ou nom du serveur

auth (alias : touch)

Ré-authentication, met à jour le jeton d’accès pour un serveur déjà enregistré.

OptionAliasDescriptionRequis
--server-sID ou nom du serveur
--login-uIdentifiant ou adresse e-mail de l’utilisateur
--password-pMot de passe de l’utilisateur

Commandes paths

Sous-commandeAliasDescription
listlsLister les chemins de synchronisation par serveur
addmkAjouter un nouveau chemin local/distant à synchroniser
setviModifier les options d’un chemin existant
removermSupprimer un chemin synchronisé
updateupMettre à jour les chemins depuis les dernières infos serveur
flushresetSupprimer les snapshots d’un chemin synchronisé

add (alias : mk)

Ajoute un chemin local / distant à synchroniser.

OptionAliasDescriptionRequisValeurs possiblesPar défaut
--server-sID ou nom du serveur
--localPath-lChemin local vers un fichier ou dossier
--remotePath-rChemin distant (spaces, personal, ou shares)
--name-nNom personnalisé pour la synchronisation
--mode-mMode de synchronisationdownload, upload, both
--diffMode-dMode de détection des différencesfast, securefast
--conflictMode-cStratégie en cas de conflit (si --mode both)recent, local, remoterecent

set (alias : vi)

Modifie les paramètres de synchronisation d’un chemin.

OptionAliasDescriptionRequisValeurs possibles
--server-sID ou nom du serveur
--path-pID ou nom du chemin synchronisé
--name-nNouveau nom de synchronisation
--mode-mMode de synchronisationdownload, upload, both
--diffMode-dMode de détection des différencesfast, secure
--conflictMode-cStratégie de résolution des conflits (si --mode both)recent, local, remote

remove (alias : rm)

Supprime un chemin déjà synchronisé.

OptionAliasDescriptionRequis
--server-sID ou nom du serveur
--path-pID ou nom du chemin synchronisé

update (alias : up)

Met à jour tous les chemins synchronisés d’un serveur à partir des dernières informations du serveur.

OptionAliasDescriptionRequis
--server-sID ou nom du serveur

flush (alias : reset)

Supprime les snapshots (états précédents) d’un chemin synchronisé.

OptionAliasDescriptionRequis
--server-sID ou nom du serveur
--path-pID ou nom du chemin synchronisé