Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 3.51 KB

how-to-use-cmd-tool.md

File metadata and controls

74 lines (52 loc) · 3.51 KB

How to use CMD tool?

Install

go install github.com/B1NARY-GR0UP/openalysis@latest

Usage

  • Start: Start OPENALYSIS service
  • Restart: Restart OPENALYSIS service
Usage:        
  openalysis [command] path2config.yaml

Available Commands:
  help        Help about any command
  restart     restart openalysis service
  start       start openalysis service

Flags:
  -h, --help      help for openalysis
  -v, --version   version for openalysis

NOTE: All configurations are based on the configuration file, and if flags are set, they will override the configurations in the configuration file.

Start - Start OPENALYSIS service

  • Usage
openalysis start [flags] path2config.yaml
  • Flags
Short Long Description
-t --token Your GitHub Token
-c --cron Your Cron Spec
-r --retry Retry Times
-h --help Help for Start
  • Example
openalysis start -c "@hourly" -r "5" config.yaml

Restart - Restart OPENALYSIS service

  • Usage
openalysis restart [flags] path2config.yaml
  • Flags
Short Long Description
-t --token Your GitHub Token
-c --cron Your Cron Spec
-r --retry Retry Times
-h --help Help for Restart
  • Example
openalysis restart -t "example-github-token" config.yaml