Smos Logo Smos

A comprehensive self-management system

The Smos JobHunt Tool

Documentation for the Smos JobHunt Tool, for automating application processes

The jobhunt tool can help you with application processes by creating the appropriate smos files for you, and even send application emails.

Reference

Arguments

Usage: smos-jobhunt COMMAND [--config-file FILE_PATH] [--log-level ARG] 
                    [--workflow-dir DIRECTORY_PATH] 
                    [--archive-dir DIRECTORY_PATH] 
                    [--projects-dir DIRECTORY_PATH] 
                    [--archived-projects-dir DIRECTORY_PATHPATH] 
                    [-d|--directory DIRECTORY] [-g|--goal GOAL] 
                    [-w|--waiting-threshhold TIME]

  
  Smos JobHunt Tool version: 0.1.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
  --config-file FILE_PATH  The config file to use
  --log-level ARG          The log level to use, options:
                           ["Debug","Info","Warn","Error"]
  --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
  -d,--directory DIRECTORY The directory to put jobhunt projects in
  -g,--goal GOAL           The goal for initialised projects
  -w,--waiting-threshhold TIME
                           The waiting threshold initialised projects

Available commands:
  init                     Initiate an application process
  email                    Initiate an application process by sending an email

Environment

Available environment variables:

  SMOS_JOBHUNT_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_JOBHUNT_ARCHIVE_DIR
                         Archive directory
  SMOS_JOBHUNT_CONFIG_FILE
                         Workflow directory
  SMOS_JOBHUNT_DIRECTORY
                         Text version of the email template
                         file
  SMOS_JOBHUNT_EMAIL_FROM_ADDRESS
                         Email from address
  SMOS_JOBHUNT_EMAIL_FROM_NAME
                         Email from name
  SMOS_JOBHUNT_EMAIL_HTML_TEMPLATE
                         HTML version of the email template
                         file
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD
                         SMTP Password
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE
                         SMTP Password file
  SMOS_JOBHUNT_EMAIL_SMTP_PORT
                         SMTP Server port
  SMOS_JOBHUNT_EMAIL_SMTP_SERVER
                         SMTP Server domain
  SMOS_JOBHUNT_EMAIL_SMTP_USERNAME
                         SMTP Username
  SMOS_JOBHUNT_EMAIL_SUBJECT_TEMPLATE
                         Subject of the email template file
  SMOS_JOBHUNT_EMAIL_TEXT_TEMPLATE
                         Text version of the email template
                         file
  SMOS_JOBHUNT_GOAL
                         The goal for initiated projects
  SMOS_JOBHUNT_LOG_LEVEL
                         The minimal severity of log
                         messages
  SMOS_JOBHUNT_PROJECTS_DIR
                         Projects directory
  SMOS_JOBHUNT_WATIING_THRESHOLD
                         The waiting threshold for
                         initiated projects
  SMOS_JOBHUNT_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>
email: # optional
  # The email configuration
  # or null
  # EmailConfiguration
  from-name: # optional
    # The from name for sending email
    # or null
    <string>
  from-address: # optional
    # The from address for sending email
    # or null
    <string>
  smtp: # optional
    # The from address for sending email
    # or null
    # SMTPConfiguration
    server: # required
      # The smtp server
      # or null
      <string>
    port: # optional
      # The smtp server port
      # or null
      <number> # between 0 and 65535
    username: # optional
      # The username to authenticate with the smtp server
      # or null
      <string>
    password: # optional
      # The password to authenticate with the smtp server
      # or null
      <string>
    password-file: # optional
      # Path to a file with the password to authenticate with the smtp server
      # or null
      <string>
jobhunt: # optional
  # The jobhunt tool configuration
  # or null
  # JobHuntConfiguration
  log-level: # optional
    # Minimal severity of log messages
    # or null
    def: LogLevel
    # The log level to use, options:
    # ["Debug","Info","Warn","Error"]
    <string>
  directory: # optional
    # Directory, relative to the projects dir, or absolute
    # or null
    <string>
  goal: # optional
    # The goal property for initialised projects
    # or null
    def: PropertyValue
    <string>
  waiting-threshold: # optional
    # The waiting threshold for initialised projects
    # or null
    def: Time
    # any of
    [ # Time string, for example:
      #  2s
      #  2 seconds
      #  3m
      #  3 minutes
      #  4h
      #  4 hours
      #  5d
      #  5 days
      #  6w
      #  6 weeks
      #  7mo
      #  7 months
      #  8y
      #  8 years
      <string>
    , # Interpreted as a number of days
      <number> # between 0 and 18446744073709551615
    ]
  email: # optional
    # The configuration for the email command
    # or null
    # SendEmailConfiguration 
    email-subject-template: # optional
      # Template file for the subject of the email
      # or null
      <string>
    email-text-template: # optional
      # Template file for the text version of the email
      # or null
      <string>
    email-html-template: # optional
      # Template file for the text version of the email
      # or null
      <string>