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.4.1

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
   version     Show version
   help, h     Shows a list of commands or help for one command
   completion  Output shell completion script for bash, zsh, fish, or Powershell

GLOBAL OPTIONS:
   --log-level string  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

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

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

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

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

github-comment version​

$ github-comment version --help
NAME:
   github-comment version - Show version

USAGE:
   github-comment version

OPTIONS:
   --json, -j  Output version in JSON format
   --help, -h  show help

github-comment completion​

$ github-comment completion --help
NAME:
   github-comment completion - Output shell completion script for bash, zsh, fish, or Powershell

USAGE:
   github-comment completion

DESCRIPTION:
   Output shell completion script for bash, zsh, fish, or Powershell.
   Source the output to enable completion.

   # .bashrc
   source <(github-comment completion bash)

   # .zshrc
   source <(github-comment completion zsh)

   # fish
   github-comment completion fish > ~/.config/fish/completions/github-comment.fish

   # Powershell
   Output the script to path/to/autocomplete/github-comment.ps1 an run it.


OPTIONS:
   --help, -h  show help