SmosTo use this tool, you will want to configure an oauth token. You can follow this guide from GitHub to create one.
A comprehensive self-management system
A comprehensive self-management system
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.
--config-file Path to the configuration file
list List relevant GitHub issues
import Import a GitHub issue as a smos project
URL The url to the issue to import
--force Overwrite an existing file default: False
--file|-f File to put the resulting project in
--directory|-d Directory to put the resulting project in
--workflow-dir The workflow directory
--archive-dir The archive directory
--projects-dir The projects directory
--archived-projects-dir The archived projects directory
--oauth-token-file Path to an OAuth token for contacting GitHub
--oauth-token|-g OAuth token for contacting GitHub
SMOS_CONFIG_FILE FILE_PATH Path to the configuration file SMOS_WORKFLOW_DIR DIRECTORY_PATH The workflow directory SMOS_ARCHIVE_DIR DIRECTORY_PATH The archive directory SMOS_PROJECTS_DIR DIRECTORY_PATH The projects directory SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH The archived projects directory SMOS_GITHUB_OAUTH_TOKEN_FILE FILE_PATH Path to an OAuth token for contacting GitHub SMOS_GITHUB_OAUTH_TOKEN OAUTH_TOKEN OAuth token for contacting GitHub
The workflow directory
workflow-dir:
# or null
<string>
The archive directory
archive-dir:
# or null
<string>
The projects directory
projects-dir:
# or null
<string>
The archived projects directory
archived-projects-dir:
# or null
<string>
Table background colours
default: UseTableBackground (Bicolour (Just (Colour8Bit 234)) (Just (Colour8Bit 235)))
colour.background:
# 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
<integer> # 8 bit unsigned integer
, # Colour24Bit
red: # required
# The red component, [0..255]
<integer> # 8 bit unsigned integer
green: # required
# The green component, [0..255]
<integer> # 8 bit unsigned integer
blue: # required
# The blue component, [0..255]
<integer> # 8 bit unsigned integer
]
, # 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
]
Path to an OAuth token for contacting GitHub
github.oauth-token-file:
# or null
<string>
OAuth token for contacting GitHub
github.oauth-token:
# or null
<string>
Usage: smos-github [--config-file FILE_PATH] COMMAND [--workflow-dir DIRECTORY_PATH] [--archive-dir DIRECTORY_PATH] [--projects-dir DIRECTORY_PATH] [--archived-projects-dir DIRECTORY_PATH] [--oauth-token-file FILE_PATH | --oauth-token|-g OAUTH_TOKEN]
All settings:
Show this help text
switch: -h|--help
Output version information
switch: --version
Path to the configuration file
option: --config-file FILE_PATH
env: SMOS_CONFIG_FILE FILE_PATH
The workflow directory
option: --workflow-dir DIRECTORY_PATH
env: SMOS_WORKFLOW_DIR DIRECTORY_PATH
config:
workflow-dir: # or null
<string>
The archive directory
option: --archive-dir DIRECTORY_PATH
env: SMOS_ARCHIVE_DIR DIRECTORY_PATH
config:
archive-dir: # or null
<string>
The projects directory
option: --projects-dir DIRECTORY_PATH
env: SMOS_PROJECTS_DIR DIRECTORY_PATH
config:
projects-dir: # or null
<string>
The archived projects directory
option: --archived-projects-dir DIRECTORY_PATH
env: SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH
config:
archived-projects-dir: # or null
<string>
Table background colours
config:
colour.background: # 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
<integer> # 8 bit unsigned integer
, # Colour24Bit
red: # required
# The red component, [0..255]
<integer> # 8 bit unsigned integer
green: # required
# The green component, [0..255]
<integer> # 8 bit unsigned integer
blue: # required
# The blue component, [0..255]
<integer> # 8 bit unsigned integer
]
, # 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
]
default: UseTableBackground (Bicolour (Just (Colour8Bit 234)) (Just (Colour8Bit 235)))
Path to an OAuth token for contacting GitHub
option: --oauth-token-file FILE_PATH
env: SMOS_GITHUB_OAUTH_TOKEN_FILE FILE_PATH
config:
github.oauth-token-file: # or null
<string>
OAuth token for contacting GitHub
option: --oauth-token|-g OAUTH_TOKEN
env: SMOS_GITHUB_OAUTH_TOKEN OAUTH_TOKEN
config:
github.oauth-token: # or null
<string>
All commands:
List relevant GitHub issues
command: list
Import a GitHub issue as a smos project
command: import
The url to the issue to import
argument: URL
Overwrite an existing file
switch: --force
default: False
File to put the resulting project in
option: --file|-f FILE_PATH
Directory to put the resulting project in
option: --directory|-d DIRECTORY_PATH
Options:
-h|--help Show this help text
--version Output version information
--config-file Path to the configuration file
list List relevant GitHub issues
import Import a GitHub issue as a smos project
URL The url to the issue to import
--force Overwrite an existing file default: False
--file|-f File to put the resulting project in
--directory|-d Directory to put the resulting project in
--workflow-dir The workflow directory
--archive-dir The archive directory
--projects-dir The projects directory
--archived-projects-dir The archived projects directory
--oauth-token-file Path to an OAuth token for contacting GitHub
--oauth-token|-g OAuth token for contacting GitHub
Environment Variables:
SMOS_CONFIG_FILE FILE_PATH Path to the configuration file
SMOS_WORKFLOW_DIR DIRECTORY_PATH The workflow directory
SMOS_ARCHIVE_DIR DIRECTORY_PATH The archive directory
SMOS_PROJECTS_DIR DIRECTORY_PATH The projects directory
SMOS_ARCHIVED_PROJECTS_DIR DIRECTORY_PATH The archived projects directory
SMOS_GITHUB_OAUTH_TOKEN_FILE FILE_PATH Path to an OAuth token for contacting GitHub
SMOS_GITHUB_OAUTH_TOKEN OAUTH_TOKEN OAuth token for contacting GitHub
Configuration Values:
The workflow directory
workflow-dir:
# or null
<string>
The archive directory
archive-dir:
# or null
<string>
The projects directory
projects-dir:
# or null
<string>
The archived projects directory
archived-projects-dir:
# or null
<string>
Table background colours
default: UseTableBackground (Bicolour (Just (Colour8Bit 234)) (Just (Colour8Bit 235)))
colour.background:
# 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
<integer> # 8 bit unsigned integer
, # Colour24Bit
red: # required
# The red component, [0..255]
<integer> # 8 bit unsigned integer
green: # required
# The green component, [0..255]
<integer> # 8 bit unsigned integer
blue: # required
# The blue component, [0..255]
<integer> # 8 bit unsigned integer
]
, # 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
]
Path to an OAuth token for contacting GitHub
github.oauth-token-file:
# or null
<string>
OAuth token for contacting GitHub
github.oauth-token:
# or null
<string>