https://github.com/algolia/algoliasearch-client-cmd
Algolia Search Command Line API Client
https://github.com/algolia/algoliasearch-client-cmd
Last synced: about 1 year ago
JSON representation
Algolia Search Command Line API Client
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-cmd
- Owner: algolia
- Created: 2013-05-25T08:02:21.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2018-04-18T16:13:14.000Z (about 8 years ago)
- Last Synced: 2025-04-25T11:53:14.754Z (about 1 year ago)
- Language: Shell
- Size: 185 KB
- Stars: 21
- Watchers: 87
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AlgoliaSearch REST API CLI Client
=================================
This API client has been done to ease the usage of Algolia's REST API from the command line. It's a [cURL](https://curl.haxx.se/docs/manpage.html) wrapper handling the retry strategy complexity for you.
# Usage
```
$ ./algoliasearch-cmd.sh (GET|POST|PUT|DELETE) /1/ [cURL arguments]
```
Examples:
* Test if the service is alive:
```
$ APPLICATION_ID=******** API_KEY=******** ./algoliasearch-cmd.sh GET /1/isalive
```
* Delete an index:
```
$ APPLICATION_ID=******** API_KEY=******** ./algoliasearch-cmd.sh DELETE /1/indexes/myindextodelete
```
* Set the settings of an index:
```
$ APPLICATION_ID=******** API_KEY=******** ./algoliasearch-cmd.sh PUT /1/indexes/myindex/settings -d '{"attributesToIndex": ["title", "description"]}'
```
* Search:
```
$ APPLICATION_ID=******** API_KEY=******** ./algoliasearch-cmd.sh POST /1/indexes/myindex/query -d '{"query": "test"}'
```