grafana-find/README.md

50 lines
934 B
Markdown

# Grafana Find
Search for a string both in the grafana queries and in the variables.
## Requirements
* Git
* Grafana
## Installation
It's recommended to install the package globally.
```text
$ npm i -g grafana-find
$ grafana-find <string>
```
You can also install locally and use the *npx* command to execute it.
```text
$ npm install grafana-find
$ npx grafana-find <string>
```
Create a file ".grafana-find.json" with this content to don't put everytime the credentials:
```text
{
"grafanaUrl": "<server>",
"user": "<user>",
"password": "<pass>"
}
```
You need put the file into user folder ( Windows: %HOMEPATH% || Linux: $HOME ), the user and password are optional.
## How to use
Execute *grafana-find* with the desired command.
```text
$ [npx] grafana-find [-h|--help] [-v|--version] <string>
```
## Built with
* [Git](https://git-scm.com/)
* [nodejs](https://nodejs.org/)
* [NodeGit](https://www.nodegit.org/)