- Created by spinscale
- 🗓 Last Updated: 12/10/21 09:18:36
- 🌟 Stars on GitHub: 16
- Love this? Consider supporting the creator by Starring or Sponsoring this on GitHub!
- Get Source Code
From their README
This project is unmaintained!
Note: This project is discontinued and has a successor at https://github.com/spinscale/alfred-workflow-elastic-docs.cr. Please go with that project instead.
Elasticsearch documentation alfred workflow
An alfred workflow, that queries the Elastic documentation and allows you to open the documentation in a browser directly from Alfred.
Note: You will need the Alfred Powerpack to use this workflow - which is commercial software. Check out the Alfred app website.
You can download the workflow from the packal alfred workflow repository, if you don't want to build it yourself.
Note: You need to have node.js installed to get up and running. You can check by executing
node --version, as you need a node version >= 12.0 (LTS was 12.18.1, when writing this).
The keyword to trigger the search in Alfred is
elastic by default.
You can search across the whole documentation, or you can limit by a product by using something like
elastic b beat. These are the available product abbreviations:
||Elastic Cloud Enterprise|
||App Search/Site Search|
In addition when specifying a product, you can also specify a version like
elastic w 2.3 execute watch
You need the
zip binary installed. Run
npm install and then just run
npm run package and you will end up with a
elastic.alfredworkflow that you can open (doubleclick or call
open on the command line) and import. Again, if you just want to use this workflow, download it from the packal repository linked above.
In order to test your workflow it is easier to create a new workflow in Alfred, that points to your development repository with an absolute path pointing to the
Alternatively you can run the tests to ensure everything works and use the
index-cli.js tool to check the output against the suggest endpoint, which does not require you to import any workflow in Alfred at all.
In order to run your tests, just execute
This is licensed under Apache2 license, because open source...!
- Colin for testing, feedback, fixes and documentation improvements.
- Sindre Sorhus for code improvements