{"id":13768631,"url":"https://github.com/spinscale/alfred-workflow-elastic-docs","last_synced_at":"2025-05-10T23:31:35.403Z","repository":{"id":47413971,"uuid":"63486531","full_name":"spinscale/alfred-workflow-elastic-docs","owner":"spinscale","description":"An alfred workflow to easily search the elastic documentation","archived":true,"fork":false,"pushed_at":"2021-10-12T09:18:36.000Z","size":896,"stargazers_count":15,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-17T03:31:48.967Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spinscale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-16T14:26:52.000Z","updated_at":"2024-08-19T16:52:25.000Z","dependencies_parsed_at":"2022-08-23T02:00:13.613Z","dependency_job_id":null,"html_url":"https://github.com/spinscale/alfred-workflow-elastic-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinscale%2Falfred-workflow-elastic-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinscale%2Falfred-workflow-elastic-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinscale%2Falfred-workflow-elastic-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spinscale%2Falfred-workflow-elastic-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spinscale","download_url":"https://codeload.github.com/spinscale/alfred-workflow-elastic-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253497296,"owners_count":21917683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T16:01:23.748Z","updated_at":"2025-05-10T23:31:34.862Z","avatar_url":"https://github.com/spinscale.png","language":"JavaScript","funding_links":[],"categories":["Documentation"],"sub_categories":[],"readme":"# This project is unmaintained!\n\n**Note**: This project is discontinued and has a successor at\nhttps://github.com/spinscale/alfred-workflow-elastic-docs.cr. *Please go\nwith that project instead*.\n\n# Elasticsearch documentation alfred workflow\n\nAn alfred workflow, that queries the Elastic documentation and allows you to open the documentation in a browser directly from Alfred.\n\n![Example](screenshot.png)\n\n**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.\n\n## Download\n\nYou 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.\n\n**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 \u003e= 12.0 (LTS was 12.18.1, when writing this).\n\n## Usage\n\nThe keyword to trigger the search in Alfred is `elastic` by default.\n\nYou 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:\n\n| Letter | Product                              |\n| ------ | ------------------------------------ |\n| `b`    | libbeat                              |\n| `mb`   | Metricbeat                           |\n| `pb`   | Packetbeat                           |\n| `wb`   | Winlogbeat                           |\n| `fb`   | Filebeat                             |\n| `jb`   | Journalbeat                          |\n| `fb`   | Functionbeat                         |\n| `e`    | Elasticsearch                        |\n| `es`   | Elasticsearch                        |\n| `l`    | Logstash                             |\n| `ls`   | Logstash                             |\n| `k`    | Kibana                               |\n| `c`    | Cloud                                |\n| `ece`  | Elastic Cloud Enterprise             |\n| `i`    | Infrastructure                       |\n| `cs`   | Clients                              |\n| `sw`   | App Search/Site Search               |\n| `a`    | APM                                  |\n| `apm`  | APM                                  |\n\nIn addition when specifying a product, you can also specify a version like `elastic w 2.3 execute watch`\n\n## Packaging\n\nYou 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.\n\n## Development\n\nIn 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.\nAlternatively 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.\n\nIn 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).\n\n## License\n\nThis is licensed under Apache2 license, because [open source...](https://www.flickr.com/photos/nez/8725092093)!\n\n## Thanks\n\n* [Colin](https://github.com/colings86) for testing, feedback, fixes and documentation improvements.\n* [Sindre Sorhus](https://github.com/sindresorhus) for code improvements\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinscale%2Falfred-workflow-elastic-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspinscale%2Falfred-workflow-elastic-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinscale%2Falfred-workflow-elastic-docs/lists"}