https://github.com/spinscale/alfred-workflow-elastic-docs

An alfred workflow to easily search the elastic documentation
https://github.com/spinscale/alfred-workflow-elastic-docs

Last synced: about 2 months ago
JSON representation

An alfred workflow to easily search the elastic documentation

• Host: GitHub
• URL: https://github.com/spinscale/alfred-workflow-elastic-docs
• Owner: spinscale
• License: apache-2.0
• Archived: true
• Created: 2016-07-16T14:26:52.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2021-10-12T09:18:36.000Z (almost 3 years ago)
• Last Synced: 2024-05-02T14:43:03.411Z (5 months ago)
• Language: JavaScript
• Size: 875 KB
• Stars: 16
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• alfred-workflows - Elasticsearch Documentation - Search Elasticsearch documentation. (Documentation)

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.

![Example](screenshot.png)

**Note**: You will need the Alfred [Powerpack](https://www.alfredapp.com/powerpack/) to use this workflow - which is commercial software. Check out the [Alfred app](https://www.alfredapp.com/) website.

## Download

You can download the workflow from [the packal alfred workflow repository](http://www.packal.org/workflow/elastic-documentation-search), 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).

## Usage

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:

| Letter | Product                              |

| ------ | ------------------------------------ |

| `b`    | libbeat                              |

| `mb`   | Metricbeat                           |

| `pb`   | Packetbeat                           |

| `wb`   | Winlogbeat                           |

| `fb`   | Filebeat                             |

| `jb`   | Journalbeat                          |

| `fb`   | Functionbeat                         |

| `e`    | Elasticsearch                        |

| `es`   | Elasticsearch                        |

| `l`    | Logstash                             |

| `ls`   | Logstash                             |

| `k`    | Kibana                               |

| `c`    | Cloud                                |

| `ece`  | Elastic Cloud Enterprise             |

| `i`    | Infrastructure                       |

| `cs`   | Clients                              |

| `sw`   | App Search/Site Search               |

| `a`    | APM                                  |

| `apm`  | APM                                  |

In addition when specifying a product, you can also specify a version like `elastic w 2.3 execute watch`

## Packaging

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.

## Development

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 `index.js` file.

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 `npm run test` - which will use babel to convert the code to node4 compatible javascript, before running the tests against the created code. As the tests use later node.js features, you need a recent node.js version to actually run the tests (I used 6.3.0 for development).

## License

This is licensed under Apache2 license, because [open source...](https://www.flickr.com/photos/nez/8725092093)!

## Thanks

* [Colin](https://github.com/colings86) for testing, feedback, fixes and documentation improvements.

* [Sindre Sorhus](https://github.com/sindresorhus) for code improvements