https://github.com/ceritium/flatito
Grep for YAML and JSON files
https://github.com/ceritium/flatito
cli grep json yaml
Last synced: 10 months ago
JSON representation
Grep for YAML and JSON files
- Host: GitHub
- URL: https://github.com/ceritium/flatito
- Owner: ceritium
- License: mit
- Created: 2024-03-14T19:29:53.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-08-27T16:30:17.000Z (10 months ago)
- Last Synced: 2025-08-31T06:21:28.568Z (10 months ago)
- Topics: cli, grep, json, yaml
- Language: Ruby
- Homepage: https://jose.gr/2024/03/15/flatito-grep-for-yaml-and-json-files.html
- Size: 561 KB
- Stars: 108
- Watchers: 4
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Flatito: Grep for YAML and JSON files
A kind of grep for YAML and JSON files. It allows you to search for a key and get the value and the line number where it is located.
## Meaning
[Esperanto](https://en.wiktionary.org/wiki/flatito): singular past nominal passive participle of flati ('to flatter').
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add flatito
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install flatito
### Nixpkgs package
It is also available as [nixpkgs](https://search.nixos.org/packages?channel=unstable&show=flatito) thanks to [@Rucadi](https://github.com/Rucadi)
$ nix run nixpkgs#flatito
## Usage
```sh
Usage: flatito PATH [options]
Example: flatito . -k "search string" -e "json,yaml"
Example: cat file.yaml | flatito -k "search string"
-h, --help Prints this help
-V, --version Show version
-k, --search-key=SEARCH Search string
--no-color Disable color output
-e, --extensions=EXTENSIONS File extensions to search, separated by comma, default: (json,yaml,yaml)
--no-skipping Do not skip hidden files
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ceritium/flatito. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ceritium/flatito/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Flatito project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ceritium/flatito/blob/master/CODE_OF_CONDUCT.md).