Skip to main content

Usage

$ github-comment --help
NAME:
   github-comment - post a comment to GitHub

USAGE:
   github-comment [global options] command [command options]

VERSION:
   6.3.2 (92bf17c5b20fb7a1246372b0cc9de4b850d50b4b)

COMMANDS:
   post     post a comment
   exec     execute a command and post the result as a comment
   init     scaffold a configuration file if it doesn't exist
   hide     hide issue or pull request comments
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --log-level value  log level [$GH_COMMENT_LOG_LEVEL]
   --help, -h         show help
   --version, -v      print the version

github-comment post​

$ github-comment post --help
NAME:
   github-comment post - post a comment

USAGE:
   github-comment post [command options]

OPTIONS:
   --org value                            GitHub organization name [$GH_COMMENT_REPO_ORG]
   --repo value                           GitHub repository name [$GH_COMMENT_REPO_NAME]
   --token value                          GitHub API token [$GITHUB_TOKEN, $GITHUB_ACCESS_TOKEN]
   --sha1 value                           commit sha1 [$GH_COMMENT_SHA1]
   --template value                       comment template
   --template-key value, -k value         comment template key (default: "default")
   --config value                         configuration file path [$GH_COMMENT_CONFIG]
   --pr value                             GitHub pull request number (default: 0) [$GH_COMMENT_PR_NUMBER]
   --var value [ --var value ]            template variable
   --var-file value [ --var-file value ]  template variable name and file path
   --dry-run                              output a comment to standard error output instead of posting to GitHub (default: false)
   --skip-no-token, -n                    works like dry-run if the GitHub Access Token isn't set (default: false) [$GH_COMMENT_SKIP_NO_TOKEN, $GITHUB_COMMENT_SKIP_NO_TOKEN]
   --silent, -s                           suppress the output of dry-run and skip-no-token (default: false)
   --stdin-template                       read standard input as the template (default: false)
   --update-condition value, -u value     update the comment that matches with the condition
   --help, -h                             show help

github-comment exec​

$ github-comment exec --help
NAME:
   github-comment exec - execute a command and post the result as a comment

USAGE:
   github-comment exec [command options]

OPTIONS:
   --org value                            GitHub organization name [$GH_COMMENT_REPO_ORG]
   --repo value                           GitHub repository name [$GH_COMMENT_REPO_NAME]
   --token value                          GitHub API token [$GITHUB_TOKEN, $GITHUB_ACCESS_TOKEN]
   --sha1 value                           commit sha1 [$GH_COMMENT_SHA1]
   --template value                       comment template
   --template-key value, -k value         comment template key (default: "default")
   --config value                         configuration file path [$GH_COMMENT_CONFIG]
   --pr value                             GitHub pull request number (default: 0) [$GH_COMMENT_PR_NUMBER]
   --out value [ --out value ]            output destination
   --var value [ --var value ]            template variable
   --var-file value [ --var-file value ]  template variable name and file path
   --dry-run                              output a comment to standard error output instead of posting to GitHub (default: false)
   --skip-no-token, -n                    works like dry-run if the GitHub Access Token isn't set (default: false) [$GH_COMMENT_SKIP_NO_TOKEN, $GITHUB_COMMENT_SKIP_NO_TOKEN]
   --silent, -s                           suppress the output of dry-run and skip-no-token (default: false)
   --help, -h                             show help

github-comment init​

$ github-comment init --help
NAME:
   github-comment init - scaffold a configuration file if it doesn't exist

USAGE:
   github-comment init [command options]

OPTIONS:
   --help, -h  show help

github-comment hide​

$ github-comment hide --help
NAME:
   github-comment hide - hide issue or pull request comments

USAGE:
   github-comment hide [command options]

OPTIONS:
   --org value                            GitHub organization name [$GH_COMMENT_REPO_ORG]
   --repo value                           GitHub repository name [$GH_COMMENT_REPO_NAME]
   --token value                          GitHub API token [$GITHUB_TOKEN, $GITHUB_ACCESS_TOKEN]
   --config value                         configuration file path [$GH_COMMENT_CONFIG]
   --condition value                      hide condition
   --hide-key value, -k value             hide condition key (default: "default")
   --pr value                             GitHub pull request number (default: 0) [$GH_COMMENT_PR_NUMBER]
   --sha1 value                           commit sha1
   --var value [ --var value ]            template variable
   --var-file value [ --var-file value ]  template variable name and file path
   --dry-run                              output a comment to standard error output instead of posting to GitHub (default: false)
   --skip-no-token, -n                    works like dry-run if the GitHub Access Token isn't set (default: false) [$GH_COMMENT_SKIP_NO_TOKEN, $GITHUB_COMMENT_SKIP_NO_TOKEN]
   --silent, -s                           suppress the output of dry-run and skip-no-token (default: false)
   --help, -h                             show help