Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dj95/ygrep
🔍 Grep for keys in yaml files and print their complete value.
https://github.com/dj95/ygrep
cmdline golang search tools yaml
Last synced: 4 months ago
JSON representation
🔍 Grep for keys in yaml files and print their complete value.
- Host: GitHub
- URL: https://github.com/dj95/ygrep
- Owner: dj95
- License: mit
- Created: 2020-01-27T09:09:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T07:45:56.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T23:03:40.891Z (4 months ago)
- Topics: cmdline, golang, search, tools, yaml
- Language: Go
- Size: 48.8 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🔍 ygrep
Search for keys in all yaml files of a directory(and its subdirectories).
## 📦 Requirements
- Golang(>=1.11) *(for building ygrep)*
- 🚧 Make *(dev dependency)*
- 🚧 staticcheck *(dev dependency)*
- 🚧 golint *(dev dependency)*
## 🔧 Installation
- Download the binary from the release page for your platform or run `go build -o ygrep cmd/ygrep/main.go`
- Copy the binary to a location in your `$PATH` (e.g. for linux `sudo cp ygrep /usr/local/bin/.`)
## 🚀 Usage
ygrep will help you to find key-value pairs in yaml files. For example if you'd like to
search for the all keys containing 'foo' and their related values in the `./test` directory,
you can use the commandline `ygrep -p ./test -e '.*foo.*'`. For searching recursively through
all subdirectories of `./test`, use `ygrep -rp ./test -e '.*foo.*'`.
ygrep also works similar like grep, so you are able to use `ygrep -r '.*foo.*' ./test` as an alternative to the previous example.
Feel free to test those commands with the provided yml files in the `./test` directory provided
in this repository. The first example should look like the following listing:
```
$ ./bin/ygrep -p ./test -e 'foo'
:: ./test/foo.yml
foo: bar
```
Please refer to the help page (use `-h` as flag) for more options.
```
$ ygrep -h
Usage: ygrep [OPTION]... PATTERN [PATH]
Search PATTERN in each yaml file of the PATH
Example: ygrep -ri foo ./test
PATTERN should contain a regular expression that matches the
key(s) to search for.
Options:
-e, --expression string the regular expression to use
-h, --help Print the help
-i, --insensitive use the expression case insensitive
-p, --path string choose the path to work in (default ".")
-r, --recursive search for yaml files recursively
Report bugs at: https://github.com/dj95/ygrep/issues
Homepage: https://github.com/dj95/ygrep
```
## ✅ Testing
Run `make tests` in order to run the tests for this application.
After running tests you will find a coverage report in the `./report` directory.
## 🤝 Contributing
If you are missing features or find some annoying bugs please feel free to submit an issue or a bugfix within a pull request :)
## 📝 License
© 2020 Daniel Jankowski
This project is licensed under the MIT license.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.