Command-line gem for interacting with Drumknott
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
lib
spec
.gitignore
.rubocop.yml
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
drumknott.gemspec

README.md

Drumknott CLI

Command line tool for the Drumknott search service. When invoked, it takes each of your compiled Jekyll pages and uploads them to Drumknott.

Installation

$ gem install drumknott

Usage

From within the local Jekyll site directory, using the credentials provided by Drumknott:

$ drumknott keys SITE_NAME SITE_KEY INCLUDE_PAGES
$ drumknott refresh

The keys command will save your credentials to a .drumknott file in your site's directory. Do not commit this file to git! If you don't want to have that file saved, you can alternatively use the environment variables DRUMKNOTT_NAME and DRUMKNOTT_KEY respectively.

By default, both posts and normal pages will be uploaded to Drumknott. If you only wish to include posts, the INCLUDE_PAGES argument in the keys command should be 'no'. This can also be managed via the DRUMKNOTT_PAGES environment variable.

You can have visual output of the refresh if you also include the ruby-progressbar gem in your Gemfile (or, if you're not using a Gemfile, just have that gem installed). However, if you prefer quiet even though the gem's installed, set the DRUMKNOTT_SILENT environment variable to be 'true'.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Firstly, please note the Code of Conduct for all contributions to this project. If you accept that, then the steps for contributing are probably something along the lines of:

  1. Fork it ( https://github.com/pat/drumknott/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

Licence

Copyright (c) 2016, Drumknott is developed and maintained by Pat Allan, and is released under the open MIT Licence.