Smos

A comprehensive self-management system

The Smos Sync Client

Your can synchronise your workflow directory using smos-sync-client. This synchronisation works with arbitrary amounts of time between synchronisations, so it is perfect for taking your laptop onto an airplane.

A community sync-server has been set up at https://api.smos.cs-syd.eu.

Arguments reference

Usage: smos-sync-client COMMAND [--config-file FILEPATH]
                        [--workflow-dir FILEPATH] [--archive-dir FILEPATH]
                        [--projects-dir FILEPATH]
                        [--archived-projects-dir FILEPATH] [--log-level ARG]
                        [--server-url ARG] [--username ARG] [--password ARG]
                        [--session-path ARG]
  smos-sync-client

Available options:
  -h,--help                Show this help text
  --config-file FILEPATH   The config file to use
  --workflow-dir FILEPATH  The workflow directory to use
  --archive-dir FILEPATH   The archive directory to use
  --projects-dir FILEPATH  The projects directory to use
  --archived-projects-dir FILEPATH
                           The archived projects directory to use
  --log-level ARG          The log level to use, options:
                           ["Debug","Info","Warn","Error"]
  --server-url ARG         The server to sync with
  --username ARG           The username to login to the sync server
  --password ARG           The password to login to the sync server WARNING: You
                           are trusting the system that you run this command on
                           if you pass in the password via command-line
                           arguments.
  --session-path ARG       The path to store the login session

Available commands:
  register                 Register at a sync server
  login                    Login at a sync server
  sync                     Sync with a sync server

# Configuration
workflow-dir: # optional
  # The workflow directory
  <string>
archive-dir: # optional
  # The archive directory
  <string>
projects-dir: # optional
  # The projects directory
  <string>
archived-projects-dir: # optional
  # The archived projects directory
  <string>
work-filter: # optional
  # The base work filter
  <string>
contexts: # optional
  # Contexts for the work report
  <key>: <string>
# Configuration
sync: # optional
  # Synchronisation configuration
  # SyncConfiguration
  log-level: # optional
    # The minimal severity for log messages
    <string>
  server-url: # optional
    # The url of the sync server. Example: api.smos.cs-syd.eu
    <string>
  contents-dir: # optional
    # The directory of the files to synchronise. By default this will be the workflow directory.
    <string>
  uuid-file: # optional
    # The file in which to store the server uuid
    <string>
  metadata-db: # optional
    # The file to store the metadata database in
    <string>
  ignore-files: # optional
    # Which files to ignore
    [ # Don't ignore any files
      nothing
    , # Ignore hidden files
      hidden
    ]
  username: # optional
    # The username to log into the sync server
    <string>
  password: # optional
    # The password to log into the sync server. Note that putting the password in a config file in plaintext is not safe. Only use this for automation.
    <string>
  session-path: # optional
    # The file in which to store the login session cookie
    <string>