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 FILE_PATH] 
                   [--workflow-dir DIRECTORY_PATH] 
                   [--archive-dir DIRECTORY_PATH] 
                   [--projects-dir DIRECTORY_PATH] 
                   [--archived-projects-dir DIRECTORY_PATHPATH] 
                   [-g|--github-oauth-token OAUTH_TOKEN] 
                   [--github-oauth-token-file OAUTH_TOKEN_FILE]

  
  Smos GitHub Tool version: 0.6.0
  
  Current Smos data format version: 2.0.0
  
  Oldest parseable Smos data format version: 0.0.0
  Newest parseable Smos data format version: 2.0.0

Available options:
  -h,--help                Show this help text
  --config-file FILE_PATH  The config file to use
  --workflow-dir DIRECTORY_PATH
                           The workflow directory to use
  --archive-dir DIRECTORY_PATH
                           The archive directory to use
  --projects-dir DIRECTORY_PATH
                           The projects directory to use
  --archived-projects-dir DIRECTORY_PATHPATH
                           The archived projects directory to use
  -g,--github-oauth-token OAUTH_TOKEN
                           A github OAuth token
  --github-oauth-token-file OAUTH_TOKEN_FILE
                           A github OAuth token file

Available commands:
  list                     List the relevant github issues
  import                   Import a github issue as a smos project

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_GITHUB_OAUTH_TOKEN_FILE
                         GitHub Oauth Token File
  SMOS_PROJECTS_DIR
                         Projects directory
  SMOS_WORKFLOW_DIR
                         Workflow directory

Configuration

# Configuration
workflow-dir: # optional
  # The workflow directory
  # or null
  <string>
archive-dir: # optional
  # The archive directory
  # or null
  <string>
projects-dir: # optional
  # The projects directory
  # or null
  <string>
archived-projects-dir: # optional
  # The archived projects directory
  # or null
  <string>
colour: # optional
  # Colour configuration
  # or null
  # ColourConfiguration
  background: # optional
    # The table background colours
    # any of
    [ null
    , null
    , # A single background colour
      def: Colour
      # any of
      [ <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> # between 0 and 255
      , # Colour24Bit
        red: # required
          # The red component, [0..255]
          <number> # between 0 and 255
        green: # required
          # The green component, [0..255]
          <number> # between 0 and 255
        blue: # required
          # The blue component, [0..255]
          <number> # between 0 and 255
      ]
    , # Bicolour
      even: # optional
        # background for even-numbered table-rows (0-indexed)
        # or null
        ref: Colour
      odd: # optional
        # background for odd-numbered table-rows
        # or null
        ref: Colour
    ]
github: # optional
  # The github tool configuration
  # or null
  # GitHubConfiguration
  oauth-token: # optional
    # Oauth token for accessing the github API
    # or null
    <string>
  oauth-token-file: # optional
    # Oauth token file for accessing the github API
    # or null
    <string>