# zipper-elasticsearch-local

> Run 6+ version of ElasticSearch locally

Latest version **1.0.3** (published 2021-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install zipper-elasticsearch-local
pnpm add zipper-elasticsearch-local
yarn add zipper-elasticsearch-local
bun add zipper-elasticsearch-local
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-06-23 |
| First published | 2021-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Vitalii Sikora |
| Maintainers | maveco69 |
| Keywords | elastic, elastic local, elasticsearch, elasticsearch local, es, es local, local |

## Links

- npm: https://www.npmjs.com/package/zipper-elasticsearch-local
- Repository: https://github.com/shelfio/elasticsearch-local
- Homepage: https://github.com/shelfio/elasticsearch-local#readme
- Issues: https://github.com/shelfio/elasticsearch-local/issues
- npm.io page: https://npm.io/package/zipper-elasticsearch-local

## Dependencies (3)

- [cwd](https://npm.io/package/cwd.md) 0.10.0
- [debug](https://npm.io/package/debug.md) 4.1.1
- [download-tarball](https://npm.io/package/download-tarball.md) 2.0.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-06-23
- 1.0.2 — 2021-04-05
- 1.0.1 — 2021-04-05
- 1.0.0 — 2021-03-19

## 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)

> Run any version of ElasticSearch locally

## Usage

### 0. Install

```
$ yarn add @shelf/elasticsearch-local --dev
```

### 1. Start Elasticsearch

```js
import {start} from '@shelf/elasticsearch-local';

await start({
  esVersion: '7.3.0',
  port: 9000, // optional
  clusterName: 'test', // optional
  nodeName: 'test', // optional
  indexes: [
    {
      name: 'your-index',
      // create index with options - https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html#indices-create-api-request-body
      body: {
        settings: {
          number_of_shards: '1',
          number_of_replicas: '1'
        },
        aliases: {
          'some-acc-id': {}
        },
        mappings: {
          "properties": {
            "field1" : {"type" : "text"}
        }
      }
    }
  ] // optional
});
```

### 2. Stop Elasticsearch

```js
import {stop} from '@shelf/elasticsearch-local';

await stop();
```

## Publish

```sh
$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master
```

## License

MIT © [Shelf](https://shelf.io)

---
_Source: https://npm.io/package/zipper-elasticsearch-local · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._