Smos

A comprehensive self-management system

The Smos Query Tool

The smos editor comes with some handy companion tools. smos-query is one of those and it is a query tool for your .smos files.

File structure

The smos-query tool operates in the workflow directory. See the directories documentation for more information. The smos-query tool will only consider the contents of the workflow directory for its functionality.

Reference

Arguments

Usage: smos-query COMMAND [--config-file FILEPATH] [--workflow-dir FILEPATH] 
                  [--archive-dir FILEPATH] [--projects-dir FILEPATH] 
                  [--archived-projects-dir FILEPATH]
  Smos Query Tool version 0.1.0

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

Available commands:
  entry                    Select entries based on a given filter
  report                   Run preconfigured reports
  work                     Show the work overview
  waiting                  Print the "WAITING" tasks
  next                     Print the next actions
  clock                    Print the clock table
  agenda                   Print the agenda
  projects                 Print the projects overview
  stuck                    Print the stuck projects overview
  log                      Print a log of what has happened.
  stats                    Print the stats actions and warn if a file does not
                           have one.
  tags                     Print all the tags that are in use

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_IGNORE_ARCHIVE
                         whether to ignore the archive
  SMOS_PROJECTS_DIR
                         Projects directory
  SMOS_WORKFLOW_DIR
                         Workflow directory

Configuration

# Configuration
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>
work: # optional
  # The work report configuration
  # WorkReportConfiguration
  base-filter: # optional
    # The base work filter
    <string>
  contexts: # optional
    # Contexts for the work report
    <key>: <string>
# Configuration
hide-archive: # optional
  # Whether or not to consider the archive, by default
  <boolean>
report: # optional
  # Prepared report config
  # PreparedReportConfiguration
  reports: # optional
    # Custom reports
    <key>: # PreparedReport
      description: # optional
        # A description of the report
        <string>
      filter: # optional
        # The entry filter to get the results in the report
        <string>
      columns: # optional
        - # The columns of the report
          <string>
      sorter: # optional
        # The sorter to sort the rows of the report by
        <string>
      hide-archive: # optional
        # Whether to consider the archive for the report
        <boolean>
waiting: # optional
  # Waiting report config
  # WaitingConfiguration
  threshold: # optional
    # The number of days before you've been waiting for something for too long
    <number>
work: # optional
  # Work report config
  # WorkConfiguration
  checks: # optional , default: fromList []
    - # The checks to perform and to alert about
      <string>
  time-filter: # optional
    # The property to use to filter by time
    <string>
  columns: # optional
    - # The columns in the report
      <string>
  sorter: # optional
    # The sorter to use to sort the rows
    <string>
  smart: # optional
    # Smart mode: figure out the amount of time based on the next BEGIN timestamp
    <boolean>