https://github.com/lolcommits/lolcommits-term_output
Display lolcommits within your iTerm terminal
https://github.com/lolcommits/lolcommits-term_output
fun git git-addons humor iterm2 lolcommits lolcommits-plugin ruby selfie
Last synced: 6 months ago
JSON representation
Display lolcommits within your iTerm terminal
- Host: GitHub
- URL: https://github.com/lolcommits/lolcommits-term_output
- Owner: lolcommits
- License: lgpl-3.0
- Created: 2017-09-23T12:39:21.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T02:05:19.000Z (8 months ago)
- Last Synced: 2025-03-25T04:03:47.433Z (6 months ago)
- Topics: fun, git, git-addons, humor, iterm2, lolcommits, lolcommits-plugin, ruby, selfie
- Language: Ruby
- Homepage: https://lolcommits.github.io
- Size: 1.33 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lolcommits Term Output
[](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/ci.yml)
[](http://rubygems.org/gems/lolcommits-term_output)
[](https://depfu.com/github/lolcommits/lolcommits-term_output)
[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
every time you git commit code, and archives a lolcat style image with it. Git
blame has never been so much fun!
This plugin uses the [inline image](http://iterm2.com/documentation-images.html)
feature available in [iTerm2](http://iterm2.com/index.html) to display each
lolcommit (images only) in your terminal (after committing). For example:
## Requirements
* Ruby >= 3.1
* A webcam
* [iTerm2](http://iterm2.com/index.html)
* [ImageMagick](http://www.imagemagick.org)
* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
## Installation
After installing the lolcommits gem, install this plugin with:
$ gem install lolcommits-term_output
Then configure to enable and set the remote endpoint:
$ lolcommits --config -p term_output
# set enabled to `true`
That's it! Your next lolcommit will be displayed within your terminal. To
disable use:
$ lolcommits --config -p term_output
# and set enabled to `false`
## Development
Check out this repo and run `bin/setup`, this will install all dependencies and
generate docs. Use `bundle exec rake` to run all tests.
You can also run `bin/console` for an interactive prompt that will allow you to
experiment with the gem code.
## Tests
MiniTest is used for testing. Run the test suite with:
$ rake test
## Docs
Generate docs for this gem with:
$ rake rdoc
## Troubles?
If you think something is broken or missing, please raise a new
[issue](https://github.com/lolcommits/lolcommits-term_output/issues). Take a
moment to check it hasn't been raised in the past (and possibly closed).
## Contributing
Bug [reports](https://github.com/lolcommits/lolcommits-term_output/issues) and
[pull requests](https://github.com/lolcommits/lolcommits-term_output/pulls) are
welcome on GitHub.
When submitting pull requests, remember to add tests covering any new behaviour,
and ensure all tests are passing on CI. Read the [contributing
guidelines](https://github.com/lolcommits/lolcommits-term_output/blob/master/CONTRIBUTING.md)
for more details.
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the [Contributor
Covenant](http://contributor-covenant.org) code of conduct. See
[here](https://github.com/lolcommits/lolcommits-term_output/blob/master/CODE_OF_CONDUCT.md)
for more details.
## License
The gem is available as open source under the terms of
[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
## Links
* [CI](https://github.com/lolcommits/lolcommits-term_output/actions/workflows/ci.yml)
* [RDoc](https://rubydoc.info/gems/lolcommits-term_output)
* [Issues](http://github.com/lolcommits/lolcommits-term_output/issues)
* [Report a bug](http://github.com/lolcommits/lolcommits-term_output/issues/new)
* [Gem](http://rubygems.org/gems/lolcommits-term_output)
* [GitHub](https://github.com/lolcommits/lolcommits-term_output)