snippet_cli

snippet_cli is a gem for generating valid yaml configurations for snippets for the program Espanso. Additionally, it includes a few espanso related utilities, like commands to check your matchfile for validity against the Espanso schema, or for conflicting triggers in your matchfile.

Installation

Install it using command:

$ sudo gem install snippet_cli

Usage

TODO: Write usage instructions here

Development

This project uses devenv (Nix-based) for environment management.

First-time setup

Install Nix and devenv
Clone the repo: bash git clone https://github.com/ajmarkow/snippet_cli.git cd snippet_cli
Enter the development environment: bash devenv shell
Install dependencies: bash bundle install
Run the tests to verify everything works: bash bundle exec rake spec

Releasing a new version

Update the version number in lib/snippet_cli/version.rb
Commit with the message containing gem-release-ready — CI will build and push the gem to RubyGems automatically once tests pass

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snippet_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the SnippetCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.