# cli-algolia-manager

> The CLI to facilitate the add/reindex/delete data from algolia indexes

Latest version **0.0.2** (published 2021-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli-algolia-manager
pnpm add cli-algolia-manager
yarn add cli-algolia-manager
bun add cli-algolia-manager
```

Provides the command `clialgmanager`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-10-16 |
| First published | 2021-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 20 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | robsongajunior |
| Maintainers | robsongajunior |
| Keywords | algolia, cli, search, api |

## Links

- npm: https://www.npmjs.com/package/cli-algolia-manager
- Repository: https://github.com/robsongajunior/cli-algolia-manager
- Homepage: https://github.com/robsongajunior/cli-algolia-manager/blob/main/README.md
- Issues: https://github.com/robsongajunior/cli-algolia-manager/issues
- npm.io page: https://npm.io/package/cli-algolia-manager

## Dependencies (3)

- [args-parser](https://npm.io/package/args-parser.md) ^1.3.0
- [stream-json](https://npm.io/package/stream-json.md) ^1.7.3
- [algoliasearch](https://npm.io/package/algoliasearch.md) ^4.10.5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-10-16

## README

# cli-algolia-manager

<p align="center">
<img src="./doc/img/cover-01.png" alt="Cover Image" title="Cover Image"/>
</br>
The CLI to help to facilitate add/delete/reindex management data from Algolia indexes.
</p>


## Easy to use

``` bash
npm install -g .
clialgmanager index=[name] lang=[lang]
```

> ATENTION: config file required to perform command.


The config file should be: `~/.algolia/conf.json`.

``` json
{
	"key": {
		"app": "OSJ19HQ1NZ", // just an example
		"api": "ebmmf0za524aoiucjek188mmapp130ad" // just an example
	},
	"lang": ["en", "ptbr"],
	"blog": {
		"en": {
			"name": "blog-rgajr-en",
			"filepath": "/Users/robson.junior/development/rgajr-blog/_site/en/algolia/data/blog.json"
		},
		"ptbr": {
			"name": "blog-rgajr-ptbr",
			"filepath": "/Users/robson.junior/development/rgajr-blog/_site/pt-br/algolia/data/blog.json"
		}
	}
}
```

|  ATTRIBUTE  |  TYPE  |                              DESCRIPTION                            |
|-------------|--------|---------------------------------------------------------------------|
|    key      | Object | Contains the identify attributes for access the app and use the api |
|   key.app   | String | Algolia APP id                                                      |
|   key.api   | String | Algolia API key                                                     |
|     lang    |  List  | The lang enabled to be used into index validation                   |
|    [blog]   | Object | Can be N objects, The name is optional, used into index param, like index=blog        |
|   blog.en   | Object | Can be many languages, Contains the object with the name of Algolia index and the filepath data to be publish |
| blog.en.name | String | The name of Algolia index |
| blog.en.filepath | String | The file path with data to be uploaded |

## Parameters

|  PARAMETER  |               OPTIONS                  |               DESCRIPTION             |
|-------------|----------------------------------------|---------------------------------------|
|   index     |                 ---                    | The object into index json configuration |
|    lang     |                 ---                    | The the lang of index json configuration |

## Features

|  FEATURE |                COMMAND                 |               DESCRIPTION             |
|----------|----------------------------------------|---------------------------------------|
|  reindex | node index.js index=[name] lang=[lang] | This command clean the index and reupload again |

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