Smos

A comprehensive self-management system

The Smos Archiving tool

You can archive files that you are done with. This way it can still be considered for reports using smos-query, but it is not in the way when looking at the rest of your files.

To archive a file, run smos-archive <file> and it will be moved to the archive dir. Any non-done entries will also be marked as CANCELLED.

Reference

Arguments

Usage: smos-archive [--config-file FILEPATH] FILEPATH [--workflow-dir FILEPATH]
                    [--archive-dir FILEPATH] [--projects-dir FILEPATH]
                    [--archived-projects-dir FILEPATH]
  smos-archive

Available options:
  -h,--help                Show this help text
  --config-file FILEPATH   The config file to use
  FILEPATH                 The file to archive
  --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

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_PROJECTS_DIR
                         Projects directory
  SMOS_WORKFLOW_DIR
                         Workflow directory

Configuration

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