Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Useful commands for Elasticsearch

Project Description

A command-line tool and API for various Elasticsearch operations.


pip install elastic-companion

Note: The 1.X versions of elastic-companion support Elasticsearch 1.X and the 5.X versions support Elasticsearch 5.X. This is similar to the versioning of the official library


To see the list of commands, use the -h or --help flag.

Each command has a corresponding Python module that can be imported and used as an API rather than from the command-line.


If you are using Docker and Docker Compose, then you don’t need to fiddle with python and pip manually. Otherwise, see below.

Download Python 3, then:

$ pyvenv-3.X venv
$ source venv/bin/activate
$ pip3 install -r requirements.txt
$ ./ -h

On Ubuntu, there’s a bit of an issue with pip3 and the above might not work. Then:

$ pyvenv-3.X venv --without-pip
$ source venv/bin/activate
$ cd venv
$ wget
$ python3
$ cd ..
$ pip3 install -r requirements.txt
$ ./ -h


Use nose:

$ nosetests


$ docker-compose run --rm companion nosetests


You need access to the pypi repository first, then it’s just a matter of:

$ python sdist bdist_wheel
$ twine upload dist/*
Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
elastic_companion-5.0.0-py3-none-any.whl (15.7 kB) Copy SHA256 Checksum SHA256 py3 Wheel May 9, 2017
elastic-companion-5.0.0.tar.gz (12.1 kB) Copy SHA256 Checksum SHA256 Source May 9, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting