<commit_before>
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GoDoc](https://godoc.org/github.com/google/gnxi?status.svg)](https://godoc.org/github.com/google/gnxi)
[![Go Report Card](https://goreportcard.com/badge/github.com/google/gnxi)](https://goreportcard.com/report/github.com/google/gnxi)
[![Build Status](https://travis-ci.org/google/gnxi.svg?branch=master)](https://travis-ci.org/google/gnxi)
[![codecov.io](https://codecov.io/github/google/gnxi/coverage.svg?branch=master)](https://codecov.io/github/google/gnxi?branch=master)

# gNxI Tools

A collection of tools for Network Management that use the gNMI and gNOI protocols.

*  See [gNMI Protocol documentation](https://github.com/openconfig/reference/tree/master/rpc/gnmi).
*  See [gNOI Protocol documentation](https://github.com/openconfig/reference/tree/master/rpc/gnoi).
*  See [Openconfig documentation](http://www.openconfig.net/).

## Tools

_Note_: At this stage these tools are intended for testing and as reference implementation of the protocol.

*  [gNMI Get](./gnmi_get)
*  [gNMI Target](./gnmi_target)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Docker for instructions on how to test against network equipment.

### Prerequisites

Install __go__ in your system https://golang.org/doc/install.

### Clone

Clone the project to your __go__ source folder:
```
mkdir -p $GOPATH/src/github.com/google/
cd $GOPATH/src/github.com/google/
git clone https://github.com/google/gnxi.git
```

### Running

```
cd $GOPATH/src/github.com/google/gnxi/gnmi_get
go run ./gnmi_get.go
```

## Docker

[FAUCET](https://github.com/faucetsdn/faucet) currently includes a [Dockerfile](https://github.com/faucetsdn/faucet/blob/master/Dockerfile.gnmi) to setup the environment that facilitates testing these tools against network equipment. See the [gNMI FAUCET documentation](https://github.com/faucetsdn/faucet/tree/master/gnmi) for more information.

## Disclaimer

*  This is not an official Google product.
*  See [how to contribute](CONTRIBUTING.md).<commit_msg>Update tool listing.<commit_after>
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GoDoc](https://godoc.org/github.com/google/gnxi?status.svg)](https://godoc.org/github.com/google/gnxi)
[![Go Report Card](https://goreportcard.com/badge/github.com/google/gnxi)](https://goreportcard.com/report/github.com/google/gnxi)
[![Build Status](https://travis-ci.org/google/gnxi.svg?branch=master)](https://travis-ci.org/google/gnxi)
[![codecov.io](https://codecov.io/github/google/gnxi/coverage.svg?branch=master)](https://codecov.io/github/google/gnxi?branch=master)

# gNxI Tools

A collection of tools for Network Management that use the gNMI and gNOI protocols.

## Tools

_Note_: At this stage these tools are intended for testing and as reference implementation of the protocol.

*  [gNMI Get](./gnmi_get)
*  [gNMI Target](./gnmi_target)

### Documentation

*  See [gNMI Protocol documentation](https://github.com/openconfig/reference/tree/master/rpc/gnmi).
*  See [gNOI Protocol documentation](https://github.com/openconfig/reference/tree/master/rpc/gnoi).
*  See [Openconfig documentation](http://www.openconfig.net/).

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Docker for instructions on how to test against network equipment.

### Prerequisites

Install __go__ in your system https://golang.org/doc/install.

### Clone

Clone the project to your __go__ source folder:
```
mkdir -p $GOPATH/src/github.com/google/
cd $GOPATH/src/github.com/google/
git clone https://github.com/google/gnxi.git
```

### Running

To run the binaries:

```
cd $GOPATH/src/github.com/google/gnxi/gnmi_get
go run ./gnmi_get.go
```

## Docker

[FAUCET](https://github.com/faucetsdn/faucet) currently includes a [Dockerfile](https://github.com/faucetsdn/faucet/blob/master/Dockerfile.gnmi) to setup the environment that facilitates testing these tools against network equipment. See the [gNMI FAUCET documentation](https://github.com/faucetsdn/faucet/tree/master/gnmi) for more information.

## Disclaimer

*  This is not an official Google product.
*  See [how to contribute](CONTRIBUTING.md).
{'fraction_non_alphanumeric': 0.14526268522676247, 'fraction_numerical': 0.002694207453973956, 'mean_word_length': 4.87730870712401, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 34, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3762905', 'n_tokens_mistral': 1506, 'n_tokens_neox': 1464, 'n_words': 328}