{"id":13998396,"url":"https://github.com/shelfio/elasticsearch-local","last_synced_at":"2025-06-10T08:09:01.508Z","repository":{"id":37251794,"uuid":"203761411","full_name":"shelfio/elasticsearch-local","owner":"shelfio","description":"Run any version of ElasticSearch locally","archived":false,"fork":false,"pushed_at":"2025-06-01T06:44:41.000Z","size":377,"stargazers_count":6,"open_issues_count":2,"forks_count":6,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-06-03T05:46:05.701Z","etag":null,"topics":["elasticsearch","jest","npm-package"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shelfio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-08-22T09:30:58.000Z","updated_at":"2025-06-01T06:44:43.000Z","dependencies_parsed_at":"2024-02-29T03:23:03.211Z","dependency_job_id":"82c6256b-1f83-4818-a034-2da8fbbf02f7","html_url":"https://github.com/shelfio/elasticsearch-local","commit_stats":{"total_commits":274,"total_committers":14,"mean_commits":"19.571428571428573","dds":0.6642335766423357,"last_synced_commit":"cdd7a37fd3703e30914c729f9f72305fb6e9326b"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelfio%2Felasticsearch-local","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelfio%2Felasticsearch-local/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelfio%2Felasticsearch-local/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelfio%2Felasticsearch-local/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shelfio","download_url":"https://codeload.github.com/shelfio/elasticsearch-local/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelfio%2Felasticsearch-local/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259033839,"owners_count":22795772,"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":["elasticsearch","jest","npm-package"],"created_at":"2024-08-09T19:01:38.107Z","updated_at":"2025-06-10T08:09:01.482Z","avatar_url":"https://github.com/shelfio.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# elasticsearch-local [![CircleCI](https://circleci.com/gh/shelfio/elasticsearch-local/tree/master.svg?style=svg)](https://circleci.com/gh/shelfio/elasticsearch-local/tree/master) ![](https://img.shields.io/badge/code_style-prettier-ff69b4.svg) [![npm (scoped)](https://img.shields.io/npm/v/@shelf/elasticsearch-local.svg)](https://www.npmjs.com/package/@shelf/elasticsearch-local)\n\n\u003e Run any version of ElasticSearch locally\n\n## Usage\n\n### 0. Install\n\n```\n$ yarn add @shelf/elasticsearch-local --dev\n```\n\n### 1. Start Elasticsearch\n\n```js\nimport {start} from '@shelf/elasticsearch-local';\n\nawait start({\n  esVersion: '8.2.2',\n  port: 9000, // optional\n  clusterName: 'test', // optional\n  nodeName: 'test', // optional\n  indexes: [\n    {\n      name: 'your-index',\n      // create index with options - https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html#indices-create-api-request-body\n      body: {\n        settings: {\n          number_of_shards: '1',\n          number_of_replicas: '1'\n        },\n        aliases: {\n          'some-acc-id': {}\n        },\n        mappings: {\n          \"properties\": {\n            \"field1\" : {\"type\" : \"text\"}\n        }\n      }\n    }\n  ] // optional\n});\n```\n\n### 2. Stop Elasticsearch\n\n```js\nimport {stop} from '@shelf/elasticsearch-local';\n\nstop();\n```\n\n## Publish\n\n```sh\n$ git checkout master\n$ yarn version\n$ yarn publish\n$ git push origin master --tags\n```\n\n## License\n\nMIT © [Shelf](https://shelf.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshelfio%2Felasticsearch-local","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshelfio%2Felasticsearch-local","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshelfio%2Felasticsearch-local/lists"}