{"id":18637530,"url":"https://github.com/dutchcoders/elastico","last_synced_at":"2025-06-27T23:32:25.748Z","repository":{"id":57523513,"uuid":"52965786","full_name":"dutchcoders/elastico","owner":"dutchcoders","description":"Commandline tool for Elasticsearch","archived":false,"fork":false,"pushed_at":"2016-08-19T08:29:12.000Z","size":828,"stargazers_count":29,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T16:14:59.821Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dutchcoders.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-02T13:44:00.000Z","updated_at":"2024-11-07T13:56:55.000Z","dependencies_parsed_at":"2022-08-28T11:12:29.885Z","dependency_job_id":null,"html_url":"https://github.com/dutchcoders/elastico","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/dutchcoders/elastico","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutchcoders%2Felastico","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutchcoders%2Felastico/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutchcoders%2Felastico/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutchcoders%2Felastico/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dutchcoders","download_url":"https://codeload.github.com/dutchcoders/elastico/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutchcoders%2Felastico/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262351479,"owners_count":23297628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T05:36:37.345Z","updated_at":"2025-06-27T23:32:25.726Z","avatar_url":"https://github.com/dutchcoders.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Elastico [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dutchcoders/elastico?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge) [![Build Status](https://travis-ci.org/dutchcoders/elastico.svg?branch=master)](https://travis-ci.org/dutchcoders/elastico)\n\nThe **elastico** utility works on your Elasticsearch cluster(s). You can use it to gain cluster status, search through indexes and types, copy indexes from one cluster to another, create and restore backups. \n\n## State\n\nElastico is work in progress. The software is by no means ready.\n\n## Install\nInstallation using Brew is most convenient. Brew will compile the source and maintain the installation.\n\n### Install using Brew\n```\n$ brew tap dutchcoders/homebrew-elastico\n$ brew install elastico\n```\n\n### Compiling from sourcecode\n\nMake sure at least Go 1.6 is installed.\n\n```\n$ go get github.com/dutchcoders/elastico\n```\n\n## Contributions\n\nContributions are welcome.\n\n### Creators\n\n**Remco Verhoef**\n- \u003chttps://twitter.com/remco_verhoef\u003e\n- \u003chttps://twitter.com/dutchcoders\u003e\n\n## Copyright and license\n\nCode and documentation copyright 2016 Remco Verhoef.\n\n## Usage\n\nThe `-json` parameter will give you the plain json output instead of the formatted output.\n\nThe `-host` parameter defines the url of the elasticsearch cluster to operate on.\n\nThe `-debug` parameter defines debugging mode for all requests and responses.\n\nFor convenience, the following environment variables can be set:\n\n`ELASTICO_HOST` the server to use e.g. http://127.0.0.1:9200/\n\n`ELASTICO_INDEX` the index to use\n\n`ELASTICO_TYPE` the type to use\n\n### Templates\n\nEvery output template can be customized by creating a Go template in \"~/.elastico\" with the name of the command. The template will get the object of the response as its parameter. For example you can create a index:stats.template to customize the output as you like.\n\n### Cluster\n#### Health\n``` \n$ elastico cluster:health \n```\n\n### State\n``` \n$ elastico cluster:state\n```\n\n### Index\n#### Create\nCreate a new index.\n```\n$ elastico index:create -index {name}\n```\n\n#### Delete\nDelete the index.\n\n```\n$ elastico index:delete -index {name}\n```\n\n#### Copy\nThis command will copy an index (type) from a location to another location. This can be on the same cluster, or on a different one.  \n\n```\n$ elastico index:copy (-index {index}) (-type {type}) {dest}\n```\n\n#### Stats\nThis command will show you the stats of the index(es) or all indexes.\n\n```\n$ elastico index:stats (-index {index})\n```\n\n#### Get\nThis command will retrieve info and settings about the index(es) or all indexes.\n\n```\n$ elastico index:get (-index {index})\n```\n\n#### Recovery\n```\n$ elastico index:recovery -index {index} \n```\n\n### Snapshots\n\n#### All\nShow snapshots.\n\n```\n$ elastico snapshots\n```\n\n#### Register\n```\n$ elastico snapshot:register -location {location} -type fs {name}\n```\n\n#### Status\n```\n$ elastico snapshot:status\n```\n\n### Search\nSearch will search through the indexes and show the relevant highlighted results.\n\n```\n$ elastico search (-disable-highlight) (-index {index}) (-type {type}) your-query\n```\n\nYou can also define your own query, and pipe it to elastico.\n```\n$ cat query.json | elastico search (-index {index}) (-type {type})\n```\n\n### Document\n#### Get\nThe get command allows to get a typed JSON document from the index based on its id. \n\n```\n$ elastico document:get -index {index} -type {type} {documentid}\n```\n\n#### Put\n```\n$ cat doc.json | elastico document:put -index {index} -type {type} {documentid}\n```\n\n### Analyze\nPerforms the analysis process on a text on a specific index and return the tokens breakdown of the text.\n\n```\n$ elastico analyze -index {index} -field {field} text-to-analyze\n```\n\n### Mapping\n\n#### Edit\nEdit will open your default editor with the current mapping of the type. The modifications you'll make will be send to Elasticsearch.\n\n```\n$ elastico mapping:edit -index {index} -type {type} \n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutchcoders%2Felastico","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdutchcoders%2Felastico","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutchcoders%2Felastico/lists"}