From d6a96ee61fa535a7bf51fd70f3826c8c2ecbd1fc Mon Sep 17 00:00:00 2001 From: Thomas von Dein Date: Tue, 28 Apr 2026 13:46:28 +0200 Subject: [PATCH] upd help --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9189e98..0dcdff7 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,21 @@ USAGE: esctl [global options] [command [command options]] VERSION: - v0.0.1 + v0.0.3 COMMANDS: - health show ES health - search, / search within an index - help, h Shows a list of commands or help for one command + search, / search within an index + index, i manage indicies + snapshot, snap manage snapshots + cluster, c manage cluster[s] + help, h Shows a list of commands or help for one command GLOBAL OPTIONS: - --debug, -d enable debugging [$ES_DEBUG] - --help, -h show help - --version, -v print the version + --debug, -d enable debugging [$ES_DEBUG] + --config string, -c string config file [$ES_CONFIG] + --cluster string, -C string cluster alias to work with + --help, -h show help + --version, -v print the version ``` Configure `esctl` with environment variables: @@ -31,6 +35,23 @@ Configure `esctl` with environment variables: - `ES_USER`: username - `ES_PASS`: password +Or create a config file such as this: + +```yaml +clusters: + default: + uri: https://es.foo.bar:9200/ + user: elastic + pass: 123456 + other: + uri: https://myes.foo:9200/ + user: elastic + pass: asdasdasd +``` + +If you want to work on a specific cluster, specify its name with the +global `-C` option. + ## Introduction FIXME