--config-file Path to the configuration file
file (default) Archive a single file
FILE_PATH The file to archive
export Export (a portion of) an archive
--directory The directory to export the archive to
--begin start date (inclusive)
--end end time (inclusive)
--yesterday yesterday
--today today
--tomorrow tomorrow
--last-week last week
--past-week the past week
--this-week this week
--coming-week the coming week
--next-week next week
--last-month last month
--past-month the past month
--this-month this month
--coming-month the coming month
--next-month next month
--last-year last year
--past-year the past year
--this-year this year
--coming-year the coming year
--next-year next year
--all-time all time
FILTER A filter to smos files by
--also-delete-originals Also delete the originals from the archive default: False
--workflow-dir The workflow directory
--archive-dir The archive directory
--projects-dir The projects directory
--archived-projects-dir The archived projects directory
--log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
SMOS_CONFIG_FILE FILE_PATH Path to the configuration file
SMOS_DIRECTORY DIRECTORY_PATH The directory to export the archive to
SMOS_WORKFLOW_DIR DIRECTORY_PATH The workflow directory
SMOS_ARCHIVE_DIR DIRECTORY_PATH The archive directory
SMOS_PROJECTS_DIR DIRECTORY_PATH The projects directory
SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH The archived projects directory
SMOS_ARCHIVE_LOG_LEVEL LOG_LEVEL Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
The directory to export the archive to
directory:
# or null
<string>
The workflow directory
workflow-dir:
# or null
<string>
The archive directory
archive-dir:
# or null
<string>
The projects directory
projects-dir:
# or null
<string>
The archived projects directory
archived-projects-dir:
# or null
<string>
Minimal severity of log messages
default: Info
examples: "Debug", "Info", "Warn", "Error"
archive.log-level:
# or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>
Usage: smos-archive [--config-file FILE_PATH] [COMMAND] [--workflow-dir DIRECTORY_PATH] [--archive-dir DIRECTORY_PATH] [--projects-dir DIRECTORY_PATH] [--archived-projects-dir DIRECTORY_PATH] [--log-level LOG_LEVEL]
All settings:
Show this help text
switch: -h|--help
Output version information
switch: --version
Path to the configuration file
option: --config-file FILE_PATH
env: SMOS_CONFIG_FILE FILE_PATH
The workflow directory
option: --workflow-dir DIRECTORY_PATH
env: SMOS_WORKFLOW_DIR DIRECTORY_PATH
config:
workflow-dir: # or null
<string>
The archive directory
option: --archive-dir DIRECTORY_PATH
env: SMOS_ARCHIVE_DIR DIRECTORY_PATH
config:
archive-dir: # or null
<string>
The projects directory
option: --projects-dir DIRECTORY_PATH
env: SMOS_PROJECTS_DIR DIRECTORY_PATH
config:
projects-dir: # or null
<string>
The archived projects directory
option: --archived-projects-dir DIRECTORY_PATH
env: SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH
config:
archived-projects-dir: # or null
<string>
Minimal severity of log messages
option: --log-level LOG_LEVEL
env: SMOS_ARCHIVE_LOG_LEVEL LOG_LEVEL
config:
archive.log-level: # or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>
default: Info
examples: "Debug", "Info", "Warn", "Error"
All commands:
Archive a single file
command: file (default)
The file to archive
argument: FILE_PATH
Export (a portion of) an archive
command: export
The directory to export the archive to
option: --directory DIRECTORY_PATH
env: SMOS_DIRECTORY DIRECTORY_PATH
config:
directory: # or null
<string>
start date (inclusive)
option: --begin DAY
end time (inclusive)
option: --end DAY
yesterday
switch: --yesterday
today
switch: --today
tomorrow
switch: --tomorrow
last week
switch: --last-week
the past week
switch: --past-week
this week
switch: --this-week
the coming week
switch: --coming-week
next week
switch: --next-week
last month
switch: --last-month
the past month
switch: --past-month
this month
switch: --this-month
the coming month
switch: --coming-month
next month
switch: --next-month
last year
switch: --last-year
the past year
switch: --past-year
this year
switch: --this-year
the coming year
switch: --coming-year
next year
switch: --next-year
all time
switch: --all-time
A filter to smos files by
argument: FILTER
Also delete the originals from the archive
switch: --also-delete-originals
default: False
Options:
-h|--help Show this help text
--version Output version information
--config-file Path to the configuration file
file (default) Archive a single file
FILE_PATH The file to archive
export Export (a portion of) an archive
--directory The directory to export the archive to
--begin start date (inclusive)
--end end time (inclusive)
--yesterday yesterday
--today today
--tomorrow tomorrow
--last-week last week
--past-week the past week
--this-week this week
--coming-week the coming week
--next-week next week
--last-month last month
--past-month the past month
--this-month this month
--coming-month the coming month
--next-month next month
--last-year last year
--past-year the past year
--this-year this year
--coming-year the coming year
--next-year next year
--all-time all time
FILTER A filter to smos files by
--also-delete-originals Also delete the originals from the archive default: False
--workflow-dir The workflow directory
--archive-dir The archive directory
--projects-dir The projects directory
--archived-projects-dir The archived projects directory
--log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
Environment Variables:
SMOS_CONFIG_FILE FILE_PATH Path to the configuration file
SMOS_DIRECTORY DIRECTORY_PATH The directory to export the archive to
SMOS_WORKFLOW_DIR DIRECTORY_PATH The workflow directory
SMOS_ARCHIVE_DIR DIRECTORY_PATH The archive directory
SMOS_PROJECTS_DIR DIRECTORY_PATH The projects directory
SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH The archived projects directory
SMOS_ARCHIVE_LOG_LEVEL LOG_LEVEL Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
Configuration Values:
The directory to export the archive to
directory:
# or null
<string>
The workflow directory
workflow-dir:
# or null
<string>
The archive directory
archive-dir:
# or null
<string>
The projects directory
projects-dir:
# or null
<string>
The archived projects directory
archived-projects-dir:
# or null
<string>
Minimal severity of log messages
default: Info
examples: "Debug", "Info", "Warn", "Error"
archive.log-level:
# or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>