https://github.com/timoguin/sigcli

CLI interface for the Signal Sciences API using the go-sigsci SDK
https://github.com/timoguin/sigcli

cli cobra go golang signal-sciences signal-sciences-api signalsciences sigsci sigsci-api viper

Last synced: about 1 month ago
JSON representation

CLI interface for the Signal Sciences API using the go-sigsci SDK

• Host: GitHub
• URL: https://github.com/timoguin/sigcli
• Owner: timoguin
• License: gpl-3.0
• Created: 2019-10-22T20:41:49.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-17T14:11:02.000Z (over 4 years ago)
• Last Synced: 2024-06-20T12:01:47.538Z (6 months ago)
• Topics: cli, cobra, go, golang, signal-sciences, signal-sciences-api, signalsciences, sigsci, sigsci-api, viper
• Language: Go
• Size: 1.41 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Signal Sciences CLI

CLI tool that interacts with the Signal Sciences API using the go-sigsci

library. Build with a simple `go build` or `make build`.

## Usage

    $ ./sigcli

    Interact with the Signal Sciences API

    Usage:

      sigcli [command]

    Available Commands:

      bash-completion     Generates bash completion scripts

      get-corp            Get info about a corp

      help                Help about any command

      list-agents         List sigsci agents

      list-corps          List sigsci corps

      list-suspicious-ips List suspicious IPS for a specific site

      list-top-attacks    List top attacks for a specific site

    Flags:

          --config string   config file (default is $HOME/.sigcli.yaml)

      -d, --debug           enable debug mode for verbose output

          --email string    SigSci email/username

      -h, --help            help for sigcli

          --token string    SigSci API token

    Use "sigcli [command] --help" for more information about a command.

## Config

The following order of precedence is used for obtaining config values:

- CLI flags

- Env vars

- Config file

All CLI commands have built-in help. Use the -h flag on any part of the CLI to

view usage docs.

You can set the following env vars:

- SIGSCI_EMAIL

- SIGSCI_TOKEN

- SIGSCI_CORP

- SIGSCI_SITE

You can also use a YAML or JSON config file:

    $ cat ~/.sigsci.yaml

    email: "YOUR_SIGSCI_EMAIL"

    token: "YOUR_SIGSCI_API_TOKEN"

    corp: "YOUR_CORP"

    site: "YOUR_SITE"