Smos

A comprehensive self-management system

The Smos Calendar Import Tool

This tool exists to import your calendar from an external source into Smos.

Make sure to run it periodically. See the instructions for running it on NixOS for automation for that on NixOS.

Reference

Arguments

Usage: smos-calendar-import [--config-file FILEPATH] [--workflow-dir FILEPATH] 
                            [--archive-dir FILEPATH] [--projects-dir FILEPATH] 
                            [--archived-projects-dir FILEPATH] [--debug]
  Smos Calendar Import 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
  --debug                  Turn on debug output

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_DEBUG             Whether to output debug info
  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>
calendar: # optional
  # Calendar configuration
  # CalendarImportConfiguration
  sources: # optional
    - # The sources to import from
      # SourceConfiguration
      name: # optional
        # The name of the source
        <string>
      source: # required
        # If you are using Google, you want to get the URL that has these labels:
        # "Use this address to access this calendar from other applications without making it public."
        # "Warning: Only share this address with those you trust to see all event details for this calendar."
        # the url to fetch or file to import
        <string>
      destination: # required
        # The destination path within the workflow directory
        <string>
  debug: # optional
    # Show the internal structure of every event in its entry's contents.
    <boolean>