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

Options

  --config-file Path to the configuration file
  init Initiate an application process
      COMPANY    The company you just applied to        
      --name|-n  The name of your contact at the company
      -e|--email Email address of the contact           
      -u|--url   The url of the job ad                  
  email Initiate an application process by sending an email
      EMAIL_ADDRESS              The email address to send the application email to
      --name|-n                  The name of the 'to' email account holder         
      --company|-c               The name of the company you are applying to       
      --url|-u                   The url of the job ad                             
      --email-template-subject   Template for the subject of the email             
      --email-template-text      Template for the text version of the email        
      --email-template-html      Template for the HTML version of the email        
      --email-from-name          From name                                         
      --email-from-address       From address                                      
      --email-smtp-server        SMTP server domain                                
      --email-smtp-port          SMTP server port                                  
      --email-smtp-username      SMTP server username                              
      --email-smtp-password-file SMTP server password file                         
      --email-smtp-password      SMTP server password                              
  --workflow-dir The workflow directory
  --archive-dir The archive directory
  --projects-dir The projects directory
  --archived-projects-dir The archived projects directory
  --directory|-d The directory to put jobhunt projects in, relative to the projects dir
  --log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
  --goal|-g The goal for initialised projects
  --waiting-threshold|-w The waiting threshold initialised projects

Environment variables

  SMOS_CONFIG_FILE FILE_PATH                        Path to the configuration file                                                                                                     
  SMOS_JOBHUNT_NAME NAME                            The name of the 'to' email account holder                                                                                          
  SMOS_JOBHUNT_COMPANY COMPANY                      The name of the company you are applying to                                                                                        
  SMOS_JOBHUNT_URL URL                              The url of the job ad                                                                                                              
  SMOS_JOBHUNT_EMAIL_TEMPLATE_SUBJECT FILE_PATH     Template for the subject of the email                                                                                              
  SMOS_JOBHUNT_EMAIL_TEMPLATE_TEXT FILE_PATH        Template for the text version of the email                                                                                         
  SMOS_JOBHUNT_EMAIL_TEMPLATE_HTML FILE_PATH        Template for the HTML version of the email                                                                                         
  SMOS_JOBHUNT_EMAIL_FROM_NAME NAME                 From name                                                                                                                          
  SMOS_JOBHUNT_EMAIL_FROM_ADDRESS EMAIL_ADDRESS     From address                                                                                                                       
  SMOS_JOBHUNT_EMAIL_SMTP_SERVER DOMAIN             SMTP server domain                                                                                                                 
  SMOS_JOBHUNT_EMAIL_SMTP_PORT PORT                 SMTP server port                                                                                                                   
  SMOS_JOBHUNT_EMAIL_SMTP_USERNAME USERNAME         SMTP server username                                                                                                               
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE FILE_PATH   SMTP server password file                                                                                                          
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD PASSWORD         SMTP server password                                                                                                               
  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_JOBHUNT_DIRECTORY DIRECTORY_PATH             The directory to put jobhunt projects in, relative to the projects dir                                                             
  SMOS_JOBHUNT_LOG_LEVEL LOG_LEVEL                  Minimal severity of log messages                                         default: Info   examples: "Debug", "Info", "Warn", "Error"
  SMOS_GOAL PROPERTY_VALUE                          The goal for initialised projects                                                                                                  
  SMOS_JOBHUNT_WAITING_THRESHOLD TIME               The waiting threshold initialised projects                                                                                         

Configuration values

  Template for the subject of the email
  jobhunt.email.template.subject:
    # or null
    <string>
  Template for the text version of the email
  jobhunt.email.template.text:
    # or null
    <string>
  Template for the HTML version of the email
  jobhunt.email.template.html:
    # or null
    <string>
  From name
  jobhunt.email.from.name:
    # or null
    <string>
  From address
  jobhunt.email.from.address:
    # or null
    <string>
  SMTP server domain
  jobhunt.email.smtp.server:
    # or null
    <string>
  SMTP server port
  jobhunt.email.smtp.port:
    # or null
    <integer> # 16 bit unsigned integer
  SMTP server username
  jobhunt.email.smtp.username:
    # or null
    <string>
  SMTP server password file
  jobhunt.email.smtp.password-file:
    # or null
    <string>
  SMTP server password
  jobhunt.email.smtp.password:
    # 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>
  The directory to put jobhunt projects in, relative to the projects dir
  jobhunt.directory:
    # or null
    <string>
  Minimal severity of log messages
  default: Info
  examples: "Debug", "Info", "Warn", "Error"
  jobhunt.log-level:
    # or null
    def: LogLevel
    # The log level to use, options:
    # ["Debug","Info","Warn","Error"]
    <string>
  The goal for initialised projects
  goal:
    # or null
    def: PropertyValue
    <string>
  The waiting threshold initialised projects
  jobhunt.waiting-threshold:
    # 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
      <integer> # 64 bit unsigned integer
    ]

Combined settings

Usage: smos-jobhunt [--config-file FILE_PATH] COMMAND [--workflow-dir DIRECTORY_PATH] [--archive-dir DIRECTORY_PATH] [--projects-dir DIRECTORY_PATH] [--archived-projects-dir DIRECTORY_PATH] [--directory|-d DIRECTORY_PATH] [--log-level LOG_LEVEL] [--goal|-g PROPERTY_VALUE] [--waiting-threshold|-w TIME]

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>

  The directory to put jobhunt projects in, relative to the projects dir
  option: --directory|-d DIRECTORY_PATH
  env: SMOS_JOBHUNT_DIRECTORY DIRECTORY_PATH
  config:
    jobhunt.directory: # or null
      <string>

  Minimal severity of log messages
  option: --log-level LOG_LEVEL
  env: SMOS_JOBHUNT_LOG_LEVEL LOG_LEVEL
  config:
    jobhunt.log-level: # or null
      def: LogLevel
      # The log level to use, options:
      # ["Debug","Info","Warn","Error"]
      <string>
  default: Info
  examples: "Debug", "Info", "Warn", "Error"

  The goal for initialised projects
  option: --goal|-g PROPERTY_VALUE
  env: SMOS_GOAL PROPERTY_VALUE
  config:
    goal: # or null
      def: PropertyValue
      <string>

  The waiting threshold initialised projects
  option: --waiting-threshold|-w TIME
  env: SMOS_JOBHUNT_WAITING_THRESHOLD TIME
  config:
    jobhunt.waiting-threshold: # 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
        <integer> # 64 bit unsigned integer
      ]

All commands:
  Initiate an application process
  command: init
    The company you just applied to
    argument: COMPANY
    
    The name of your contact at the company
    option: --name|-n NAME
    
    Email address of the contact
    option: -e|--email EMAIL_ADDRESS
    
    The url of the job ad
    option: -u|--url URL
    
  
  Initiate an application process by sending an email
  command: email
    The email address to send the application email to
    argument: EMAIL_ADDRESS
    
    The name of the 'to' email account holder
    option: --name|-n NAME
    env: SMOS_JOBHUNT_NAME NAME
    
    The name of the company you are applying to
    option: --company|-c COMPANY
    env: SMOS_JOBHUNT_COMPANY COMPANY
    
    The url of the job ad
    option: --url|-u URL
    env: SMOS_JOBHUNT_URL URL
    
    Template for the subject of the email
    option: --email-template-subject FILE_PATH
    env: SMOS_JOBHUNT_EMAIL_TEMPLATE_SUBJECT FILE_PATH
    config:
      jobhunt.email.template.subject: # or null
        <string>
    
    Template for the text version of the email
    option: --email-template-text FILE_PATH
    env: SMOS_JOBHUNT_EMAIL_TEMPLATE_TEXT FILE_PATH
    config:
      jobhunt.email.template.text: # or null
        <string>
    
    Template for the HTML version of the email
    option: --email-template-html FILE_PATH
    env: SMOS_JOBHUNT_EMAIL_TEMPLATE_HTML FILE_PATH
    config:
      jobhunt.email.template.html: # or null
        <string>
    
    From name
    option: --email-from-name NAME
    env: SMOS_JOBHUNT_EMAIL_FROM_NAME NAME
    config:
      jobhunt.email.from.name: # or null
        <string>
    
    From address
    option: --email-from-address EMAIL_ADDRESS
    env: SMOS_JOBHUNT_EMAIL_FROM_ADDRESS EMAIL_ADDRESS
    config:
      jobhunt.email.from.address: # or null
        <string>
    
    SMTP server domain
    option: --email-smtp-server DOMAIN
    env: SMOS_JOBHUNT_EMAIL_SMTP_SERVER DOMAIN
    config:
      jobhunt.email.smtp.server: # or null
        <string>
    
    SMTP server port
    option: --email-smtp-port PORT
    env: SMOS_JOBHUNT_EMAIL_SMTP_PORT PORT
    config:
      jobhunt.email.smtp.port: # or null
        <integer> # 16 bit unsigned integer
    
    SMTP server username
    option: --email-smtp-username USERNAME
    env: SMOS_JOBHUNT_EMAIL_SMTP_USERNAME USERNAME
    config:
      jobhunt.email.smtp.username: # or null
        <string>
    
    SMTP server password file
    option: --email-smtp-password-file FILE_PATH
    env: SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE FILE_PATH
    config:
      jobhunt.email.smtp.password-file: # or null
        <string>
  
    SMTP server password
    option: --email-smtp-password PASSWORD
    env: SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD PASSWORD
    config:
      jobhunt.email.smtp.password: # or null
        <string>
    
  

Options:
  -h|--help Show this help text
  --version Output version information
  --config-file Path to the configuration file
  init Initiate an application process
      COMPANY    The company you just applied to        
      --name|-n  The name of your contact at the company
      -e|--email Email address of the contact           
      -u|--url   The url of the job ad                  
  email Initiate an application process by sending an email
      EMAIL_ADDRESS              The email address to send the application email to
      --name|-n                  The name of the 'to' email account holder         
      --company|-c               The name of the company you are applying to       
      --url|-u                   The url of the job ad                             
      --email-template-subject   Template for the subject of the email             
      --email-template-text      Template for the text version of the email        
      --email-template-html      Template for the HTML version of the email        
      --email-from-name          From name                                         
      --email-from-address       From address                                      
      --email-smtp-server        SMTP server domain                                
      --email-smtp-port          SMTP server port                                  
      --email-smtp-username      SMTP server username                              
      --email-smtp-password-file SMTP server password file                         
      --email-smtp-password      SMTP server password                              
  --workflow-dir The workflow directory
  --archive-dir The archive directory
  --projects-dir The projects directory
  --archived-projects-dir The archived projects directory
  --directory|-d The directory to put jobhunt projects in, relative to the projects dir
  --log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
  --goal|-g The goal for initialised projects
  --waiting-threshold|-w The waiting threshold initialised projects

Environment Variables:
  SMOS_CONFIG_FILE FILE_PATH                        Path to the configuration file                                                                                                     
  SMOS_JOBHUNT_NAME NAME                            The name of the 'to' email account holder                                                                                          
  SMOS_JOBHUNT_COMPANY COMPANY                      The name of the company you are applying to                                                                                        
  SMOS_JOBHUNT_URL URL                              The url of the job ad                                                                                                              
  SMOS_JOBHUNT_EMAIL_TEMPLATE_SUBJECT FILE_PATH     Template for the subject of the email                                                                                              
  SMOS_JOBHUNT_EMAIL_TEMPLATE_TEXT FILE_PATH        Template for the text version of the email                                                                                         
  SMOS_JOBHUNT_EMAIL_TEMPLATE_HTML FILE_PATH        Template for the HTML version of the email                                                                                         
  SMOS_JOBHUNT_EMAIL_FROM_NAME NAME                 From name                                                                                                                          
  SMOS_JOBHUNT_EMAIL_FROM_ADDRESS EMAIL_ADDRESS     From address                                                                                                                       
  SMOS_JOBHUNT_EMAIL_SMTP_SERVER DOMAIN             SMTP server domain                                                                                                                 
  SMOS_JOBHUNT_EMAIL_SMTP_PORT PORT                 SMTP server port                                                                                                                   
  SMOS_JOBHUNT_EMAIL_SMTP_USERNAME USERNAME         SMTP server username                                                                                                               
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD_FILE FILE_PATH   SMTP server password file                                                                                                          
  SMOS_JOBHUNT_EMAIL_SMTP_PASSWORD PASSWORD         SMTP server password                                                                                                               
  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_JOBHUNT_DIRECTORY DIRECTORY_PATH             The directory to put jobhunt projects in, relative to the projects dir                                                             
  SMOS_JOBHUNT_LOG_LEVEL LOG_LEVEL                  Minimal severity of log messages                                         default: Info   examples: "Debug", "Info", "Warn", "Error"
  SMOS_GOAL PROPERTY_VALUE                          The goal for initialised projects                                                                                                  
  SMOS_JOBHUNT_WAITING_THRESHOLD TIME               The waiting threshold initialised projects                                                                                         

Configuration Values:
  Template for the subject of the email
  jobhunt.email.template.subject:
    # or null
    <string>
  Template for the text version of the email
  jobhunt.email.template.text:
    # or null
    <string>
  Template for the HTML version of the email
  jobhunt.email.template.html:
    # or null
    <string>
  From name
  jobhunt.email.from.name:
    # or null
    <string>
  From address
  jobhunt.email.from.address:
    # or null
    <string>
  SMTP server domain
  jobhunt.email.smtp.server:
    # or null
    <string>
  SMTP server port
  jobhunt.email.smtp.port:
    # or null
    <integer> # 16 bit unsigned integer
  SMTP server username
  jobhunt.email.smtp.username:
    # or null
    <string>
  SMTP server password file
  jobhunt.email.smtp.password-file:
    # or null
    <string>
  SMTP server password
  jobhunt.email.smtp.password:
    # 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>
  The directory to put jobhunt projects in, relative to the projects dir
  jobhunt.directory:
    # or null
    <string>
  Minimal severity of log messages
  default: Info
  examples: "Debug", "Info", "Warn", "Error"
  jobhunt.log-level:
    # or null
    def: LogLevel
    # The log level to use, options:
    # ["Debug","Info","Warn","Error"]
    <string>
  The goal for initialised projects
  goal:
    # or null
    def: PropertyValue
    <string>
  The waiting threshold initialised projects
  jobhunt.waiting-threshold:
    # 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
      <integer> # 64 bit unsigned integer
    ]