Smos

A comprehensive self-management system

The Smos TUI

Reference

Arguments

Usage: smos [FILE] [--config-file FILEPATH] [--workflow-dir FILEPATH] 
            [--archive-dir FILEPATH] [--projects-dir FILEPATH] 
            [--archived-projects-dir FILEPATH] [--explainer-mode]
  Smos TUI Editor version 0.1.0

Available options:
  -h,--help                Show this help text
  FILE                     the file to edit
  --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
  --explainer-mode         Activate explainer mode to show what is happening

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_EXPLAINER_MODE
                         Activate explainer mode to show
                         what is happening
  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
keys: # optional
  # Keybindings
  # KeybindingsConfiguration
  reset: # optional
    # Whether to reset all keybindings. Set this to false to add keys, set this to true to replace keys.
    <boolean>
  file: # optional
    # Keybindings for the file context
    # FileKeyConfigs
    empty: # optional
      - # Keybindings for when the file is empty
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    entry: # optional
      - # Keybindings for when an entry is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    header: # optional
      - # Keybindings for when an header is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    contents: # optional
      - # Keybindings for when an contents is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    timestamps: # optional
      - # Keybindings for when a timestamps are selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    properties: # optional
      - # Keybindings for when a properties are selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    state-history: # optional
      - # Keybindings for when a state history is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    tags: # optional
      - # Keybindings for when a tags are selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    logbook: # optional
      - # Keybindings for when a logbook is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    any: # optional
      - # Keybindings that match in any file subcontext
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
  browser: # optional
    # Keybindings for the file browser context
    # BrowserKeyConfigs
    existent: # optional
      - # Keybindings for when an existing file or directory is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    in-progress: # optional
      - # Keybindings for when an in-progress file or directory is selected
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    empty: # optional
      - # Keybindings for when the directory being browsed is empty
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    any: # optional
      - # Keybindings for any of the other file browser situations
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
  reports: # optional
    # Keybindings for the reports context
    # ReportsKeyConfigs
    next-action: # optional
      # Keybindings for the interactive next action report
      # NextActionReportKeyConfigs
      normal: # optional
        - # Keybindings for interacting with the next-action report
          # KeyConfig
          key: # required
            # The key to match
            <string>
          action: # required
            # The name of the action to perform when the key is matched
            <string>
      search: # optional
        - # Keybindings for the search in the next-action report
          # KeyConfig
          key: # required
            # The key to match
            <string>
          action: # required
            # The name of the action to perform when the key is matched
            <string>
      any: # optional
        - # Keybindings for at any point in the next action report
          # KeyConfig
          key: # required
            # The key to match
            <string>
          action: # required
            # The name of the action to perform when the key is matched
            <string>
    waiting: # optional
      # Keybindings for the interactive waiting report
      # WaitingReportKeyConfigs
      normal: # optional
        - # Keybindings for interacting with the next-action report
          # KeyConfig
          key: # required
            # The key to match
            <string>
          action: # required
            # The name of the action to perform when the key is matched
            <string>
      any: # optional
        - # Keybindings for at any point in the next action report
          # KeyConfig
          key: # required
            # The key to match
            <string>
          action: # required
            # The name of the action to perform when the key is matched
            <string>
    any: # optional
      - # Keybindings for at any point in any report
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
  help: # optional
    # Keybindings for the help context
    # HelpKeyConfigs
    help: # optional
      - # Keybindings for when in the help screen
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    search: # optional
      - # Keybindings for when the search bar is selected within the help screen
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
    any: # optional
      - # Keybindings for at any time in the help screen
        # KeyConfig
        key: # required
          # The key to match
          <string>
        action: # required
          # The name of the action to perform when the key is matched
          <string>
  any: # optional
    - # Keybindings for any context
      # KeyConfig
      key: # required
        # The key to match
        <string>
      action: # required
        # The name of the action to perform when the key is matched
        <string>
# Configuration
explainer-mode: # optional
  # Turn on explainer mode where the user can see what is happening
  <boolean>