elasticsearch

Elasticsearch CLI

A standalone Elasticsearch interactive CLI client for Go applications.

Features

• 🚀 RESTful API interaction
• 📊 CAT API support (table format)
• 🔍 Query DSL support
• 📝 JSON formatted output
• 🎯 Index and document management
• ⏱️ Query timing

Installation

go get github.com/binrchq/elasticsearch-cli

Quick Start

package main

import (
    "log"
    "os"
    
    elasticsearchcli "github.com/binrchq/elasticsearch-cli"
)

func main() {
    cli := elasticsearchcli.NewCLI(
        os.Stdin,
        "localhost",
        9200,
        "elastic",
        "password",
    )
    
    if err := cli.Connect(); err != nil {
        log.Fatal(err)
    }
    defer cli.Close()
    
    if err := cli.Start(); err != nil {
        log.Fatal(err)
    }
}

Command Format

METHOD /path [body]

Usage Examples

Cluster Information

GET /
GET /_cluster/health

CAT API

cat indices
cat nodes
cat shards

Index Operations

PUT /my-index
GET /my-index
DELETE /my-index

Document Operations

POST /my-index/_doc {"field": "value"}
GET /my-index/_doc/id
DELETE /my-index/_doc/id

Search

GET /my-index/_search
GET /my-index/_search {"query": {"match_all": {}}}

Special Commands

• help - Show help
• exit, quit - Exit
• pretty - Toggle pretty print
• timing - Toggle timing
• use <index> - Set current index
• cat <command> - CAT API commands

Requirements

• Go 1.21 or higher
• Elasticsearch 7.0 or higher

Dependencies

• github.com/elastic/go-elasticsearch/v8 - Elasticsearch client
• github.com/chzyer/readline - Readline library

License

MIT License - see LICENSE file for details.

Author

Maintained by binrc.

Related Projects

• mysql-cli - MySQL CLI
• postgres-cli - PostgreSQL CLI