Formkeep lets you access your Formkeep API data.


Add this line to your application's Gemfile:

gem 'formkeep'

And then execute:

$ bundle

Or install it yourself as:

$ gem install formkeep


You must have a ~/.formkeep.yaml file!

It should look something like this:

form_name: api_endpoint_url_in_full

You can have as many form entries as you like. They don't necessarily need to be named exactly how they are named on


Simply pass the key of the form from ~/.formkeep.yaml to the unread command to check for unread messages. If you have Sticky Notifications installed (OS X only) you can have a sticky notification created by passing the -s or --sticky flag.

formkeep unread FORM [-s]


  1. Fork it ([my-github-username]/formkeep/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request