https://github.com/pat/drumknott
Command-line gem for interacting with Drumknott
https://github.com/pat/drumknott
Last synced: 5 months ago
JSON representation
Command-line gem for interacting with Drumknott
- Host: GitHub
- URL: https://github.com/pat/drumknott
- Owner: pat
- License: mit
- Created: 2015-09-27T18:21:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-02-17T11:01:21.000Z (over 6 years ago)
- Last Synced: 2024-04-29T21:15:00.777Z (about 2 years ago)
- Language: Ruby
- Size: 30.3 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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-2020, Drumknott is developed and maintained by Pat Allan, and is released under the open MIT Licence.