Nearly auto-generated Elasticsearch/OpenSearch client

Build Status


Add this line to your application's Gemfile:

gem 'antbird'

And then execute:

$ bundle

Or install it yourself as:

$ gem install antbird



client =

# OR

client = 'test-index', type: 'test-type')

# OR

client =
  url: 'http://localhost:9200',
  scope: {
    index: 'test-index',
    type: 'test-type'

# OR

require 'faraday/net_http_persistent'
require 'faraday_middleware/aws_sigv4'
client =
  scope: {
    index: 'test-index',
    type: 'test-type'
  adapter: :net_http_persistent
) do |f|
    service: 'es',
    region: 'ap-northeast-1',
    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],

Call APIs

client =
  scope: { index: 'test-index', type: 'test-type' }

client.indices_exists? # => false
  body: {
    settings: { number_of_shards: 1 },
    mappings: {
      'test-type': {
        properties: {
          field1: { type: :text }

client.indices_exists? # => true

client.index(id: 'doc-1', body: { field1: 'foo bar' })

client.indices_refresh { query: { match_all: {} } })

client.bulk(body: [
  { index: { _id: 'doc-1' } },
  { field1: 'aaa' },
  { index: { _id: 'doc-2' } },
  { field1: 'bbb' },
  { index: { _id: 'doc-3' } },
  { field1: 'ccc' },


After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

How to support newer version of Elasticsearch/OpenSearch

  1. Add Elasticsearch version to on .github/workflows/build.yml / .github/workflows/build-os.yml
    • Only one line for x.y.* version
  2. script/generate_api_methods
    • Set GITHUB_TOKEN=*** env for GitHub API Limit


The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Antbird project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.