Smos Logo Smos

A comprehensive self-management system

The Smos GitHub Tool

Documentation for the Smos GitHub Tool, for integration with GitHub.

To use this tool, you will want to configure an oauth token. You can follow this guide from GitHub to create one.

Reference

Arguments

Usage: smos-github COMMAND [--config-file FILEPATH] [--workflow-dir FILEPATH] 
                   [--archive-dir FILEPATH] [--projects-dir FILEPATH] 
                   [--archived-projects-dir FILEPATH] 
                   [-g|--github-oauth-token OAUTH_TOKEN]
  
  Smos GitHub Tool version: 0.3.0
  
  Current Smos data format version: 1.0.0
  
  Oldest parseable Smos data format version: 0.0.0
  Newest parseable Smos data format version: 1.0.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
  -g,--github-oauth-token OAUTH_TOKEN
                           A github OAuth token

Available commands:
  list                     List the relevant github issues

Environment

Available environment variables:

  SMOS_ARCHIVED_PROJECTS_DIR
                         Archived projects directory
  SMOS_ARCHIVE_DIR
                         Archive directory
  SMOS_CONFIG_FILE
                         Workflow directory
  SMOS_GITHUB_OAUTH_TOKEN
                         Github Oauth Token
  SMOS_PROJECTS_DIR
                         Projects directory
  SMOS_WORKFLOW_DIR
                         Workflow directory

Configuration

# DirectoryConfiguration
workflow-dir: # optional
  # or <null>
  # The workflow directory
  <string>
archive-dir: # optional
  # or <null>
  # The archive directory
  <string>
projects-dir: # optional
  # or <null>
  # The projects directory
  <string>
archived-projects-dir: # optional
  # or <null>
  # The archived projects directory
  <string>
# ColourConfiguration
colour: # optional
  # or <null>
  # The colour configuration
  # ColourConfiguration
  background: # optional
    [ null
    , [ [ <string>
        , # Set this to a number between 0 and 255 that represents the colour that you want from the 8-bit colour schema.
          # See this overview on wikipedia for more information:
          # https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
          <number>
        , # Colour24Bit
          red: # required
            # The red component, [0..255]
            <number>
          green: # required
            # The green component, [0..255]
            <number>
          blue: # required
            # The blue component, [0..255]
            <number>
        ]
      , # Bicolour
        even: # optional
          [ <string>
          , # Set this to a number between 0 and 255 that represents the colour that you want from the 8-bit colour schema.
            # See this overview on wikipedia for more information:
            # https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
            <number>
          , # Colour24Bit
            red: # required
              # The red component, [0..255]
              <number>
            green: # required
              # The green component, [0..255]
              <number>
            blue: # required
              # The blue component, [0..255]
              <number>
          ]
        odd: # optional
          [ <string>
          , # Set this to a number between 0 and 255 that represents the colour that you want from the 8-bit colour schema.
            # See this overview on wikipedia for more information:
            # https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
            <number>
          , # Colour24Bit
            red: # required
              # The red component, [0..255]
              <number>
            green: # required
              # The green component, [0..255]
              <number>
            blue: # required
              # The blue component, [0..255]
              <number>
          ]
      ]
    ]
# Configuration
github: # optional
  # or <null>
  # The github tool configuration
  # GithubConfiguration
  oauth-token: # optional
    # or <null>
    # Oauth token for accessing the github API
    <string>