Skip to content

Commands

scm-engine

NAME:
   scm-engine - GitHub/GitLab automation

USAGE:
   scm-engine [global options] command [command options]

VERSION:
   dev (date: unknown; commit: unknown)

AUTHOR:
   Christian Winther <scm-engine@jippi.dev>

COMMANDS:
   gitlab   GitLab related commands
   github   GitHub related commands
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value  Path to the scm-engine config file (default: ".scm-engine.yml") [$SCM_ENGINE_CONFIG_FILE]
   --dry-run       Dry run, don't actually _do_ actions, just print them (default: false) [$SCM_ENGINE_DRY_RUN]
   --help, -h      show help
   --version, -v   print the version

COPYRIGHT:
   Christian Winther

scm-engine github

NAME:
   scm-engine github - GitHub related commands

USAGE:
   scm-engine github command [command options]

COMMANDS:
   evaluate  Evaluate a Pull Request
   help, h   Shows a list of commands or help for one command

OPTIONS:
   --api-token value  GitHub API token [$SCM_ENGINE_TOKEN]
   --base-url value   Base URL for the SCM instance (default: "https://api.github.com/") [$SCM_ENGINE_BASE_URL]
   --help, -h         show help

GLOBAL OPTIONS:
   --config value  Path to the scm-engine config file (default: ".scm-engine.yml") [$SCM_ENGINE_CONFIG_FILE]
   --dry-run       Dry run, don't actually _do_ actions, just print them (default: false) [$SCM_ENGINE_DRY_RUN]
   --help, -h      show help
   --version, -v   print the version

scm-engine github evaluate

NAME:
   scm-engine github evaluate - Evaluate a Pull Request

USAGE:
   scm-engine github evaluate [command options]  [pr_id, pr_id, ...]

OPTIONS:
   --project value  GitHub project (example: 'jippi/scm-engine') [$GITHUB_REPOSITORY]
   --id value       The Pull Request ID to process, if not provided as a CLI flag [$SCM_ENGINE_PULL_REQUEST_ID]
   --commit value   The git commit sha [$GITHUB_SHA]
   --help, -h       show help

GLOBAL OPTIONS:
   --config value  Path to the scm-engine config file (default: ".scm-engine.yml") [$SCM_ENGINE_CONFIG_FILE]
   --dry-run       Dry run, don't actually _do_ actions, just print them (default: false) [$SCM_ENGINE_DRY_RUN]
   --help, -h      show help
   --version, -v   print the version