grafana-find/README.md

50 lines
934 B
Markdown
Raw Normal View History

2022-06-17 08:39:35 +00:00
# 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
2022-06-21 16:34:18 +00:00
$ npm i -g grafana-find
2022-06-22 17:52:48 +00:00
$ grafana-find <string>
2022-06-17 08:39:35 +00:00
```
You can also install locally and use the *npx* command to execute it.
```text
$ npm install grafana-find
2022-06-21 16:11:21 +00:00
$ npx grafana-find <string>
2022-06-17 08:39:35 +00:00
```
2022-06-21 16:11:21 +00:00
Create a file ".grafana-find.json" with this content to don't put everytime the credentials:
2022-06-17 12:45:02 +00:00
```text
{
2022-06-21 15:54:01 +00:00
"grafanaUrl": "<server>",
"user": "<user>",
"password": "<pass>"
2022-06-17 12:45:02 +00:00
}
```
2022-06-22 17:52:48 +00:00
You need put the file into user folder ( Windows: %HOMEPATH% || Linux: $HOME ), the user and password are optional.
2022-06-21 16:11:21 +00:00
2022-06-17 12:45:02 +00:00
2022-06-17 08:39:35 +00:00
## How to use
Execute *grafana-find* with the desired command.
```text
2022-06-21 16:11:21 +00:00
$ [npx] grafana-find [-h|--help] [-v|--version] <string>
```
## Built with
* [Git](https://git-scm.com/)
* [nodejs](https://nodejs.org/)
* [NodeGit](https://www.nodegit.org/)