Skip to content

Latest commit

 

History

History
51 lines (47 loc) · 1.07 KB

README.md

File metadata and controls

51 lines (47 loc) · 1.07 KB
Raw

Nagini

Installing

  1. Install Go
  2. Run:
go install .
  1. Installs from $GOPATH/bin/nagini

Usage

Note: Run from $GOPATH/bin/nagini, best option is to add this to your PATH. Another option is to run from raw sources files as specified in the "Contributing" section.

  • Help
nagini --help
  • Log Pulling
nagini log [config YAML] [flags]

Examples

TODO

Building for Centos 7

  1. cd ./build/centos7
  2. ./build.sh
  3. nagini binary will be in build/centos7/output

Running from Repo

  1. Clone repo
  2. Run --help flag to see available options. (TODO: Add better info about command options)
go run . --help

Contributing

Running locally from source files

  1. Clone repo
  2. Run --help flag to see available options. (TODO: Add better info about command options)
go run . --help

Running Tests

  1. Clone repo & Open shell in the project directory.
  2. Run the following command:
go test -v ./test/...

Submitting Code

  1. Fork project
  2. Make changes
  3. Submit Pull Request with passing tests