Smos Logo Smos

A comprehensive self-management system

The Smos Archiving Tool

Documentation for the Smos Archiving tool, for manipulating your Smos archive

Reference

Arguments

Usage: smos-archive (COMMAND | FILEPATH) [--config-file FILE_PATH] 
                    [--workflow-dir DIRECTORY_PATH] 
                    [--archive-dir DIRECTORY_PATH] 
                    [--projects-dir DIRECTORY_PATH] 
                    [--archived-projects-dir DIRECTORY_PATHPATH] 
                    [--log-level ARG]

  
  Smos Archive Tool version: 0.4.0
  
  Current Smos data format version: 2.0.0
  
  Oldest parseable Smos data format version: 0.0.0
  Newest parseable Smos data format version: 2.0.0

Available options:
  -h,--help                Show this help text
  FILEPATH                 The file to archive
  --config-file FILE_PATH  The config file to use
  --workflow-dir DIRECTORY_PATH
                           The workflow directory to use
  --archive-dir DIRECTORY_PATH
                           The archive directory to use
  --projects-dir DIRECTORY_PATH
                           The projects directory to use
  --archived-projects-dir DIRECTORY_PATHPATH
                           The archived projects directory to use
  --log-level ARG          The log level to use, options:
                           ["Debug","Info","Warn","Error"]

Available commands:
  file                     Archive a single file
  export                   Export (a portion of) an archive

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_LOG_LEVEL         The minimal severity of log
                         messages
  SMOS_PROJECTS_DIR
                         Projects directory
  SMOS_WORKFLOW_DIR
                         Workflow directory

Configuration

# Configuration
workflow-dir: # optional
  # The workflow directory
  # or null
  <string>
archive-dir: # optional
  # The archive directory
  # or null
  <string>
projects-dir: # optional
  # The projects directory
  # or null
  <string>
archived-projects-dir: # optional
  # The archived projects directory
  # or null
  <string>
log-level: # optional
  # Minimal severity of log messages
  # or null
  def: LogLevel
  # The log level to use, options:
  # ["Debug","Info","Warn","Error"]
  <string>