elasticsearch-knife

Do stuff with elasticsearch

• Usage
• Commands

Usage

$ npm install -g elasticsearch-knife
$ elasticsearch-knife COMMAND
running command...
$ elasticsearch-knife (--version)
elasticsearch-knife/0.4.2 darwin-arm64 node-v18.11.0
$ elasticsearch-knife --help [COMMAND]
USAGE
  $ elasticsearch-knife COMMAND
...

Commands

• elasticsearch-knife
• Usage
• Commands
  • elasticsearch-knife count INDEX
  • elasticsearch-knife generate INDEX
  • elasticsearch-knife help [COMMAND]
  • elasticsearch-knife mapping array INDEX
  • elasticsearch-knife plugins
  • elasticsearch-knife plugins:install PLUGIN...
  • elasticsearch-knife plugins:inspect PLUGIN...
  • elasticsearch-knife plugins:install PLUGIN...
  • elasticsearch-knife plugins:link PLUGIN
  • elasticsearch-knife plugins:uninstall PLUGIN...
  • elasticsearch-knife plugins:uninstall PLUGIN...
  • elasticsearch-knife plugins:uninstall PLUGIN...
  • elasticsearch-knife plugins update

elasticsearch-knife count INDEX

Count documents

USAGE
  $ elasticsearch-knife count [INDEX] --endpoint <value>

ARGUMENTS
  INDEX  The elasticsearch index name

FLAGS
  --endpoint=<value>  (required)

DESCRIPTION
  Count documents

EXAMPLES
  $ oex count events
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: dist/commands/count/index.ts

elasticsearch-knife generate INDEX

Generate documents

USAGE
  $ elasticsearch-knife generate [INDEX] --endpoint <value> [--limit <value>] [--bulkSize <value>]

ARGUMENTS
  INDEX  The elasticsearch index name

FLAGS
  --bulkSize=<value>  [default: 500]
  --endpoint=<value>  (required)
  --limit=<value>

DESCRIPTION
  Generate documents

EXAMPLES
  $ oex generate
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: dist/commands/generate/index.ts

elasticsearch-knife help [COMMAND]

Display help for elasticsearch-knife.

USAGE
  $ elasticsearch-knife help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for elasticsearch-knife.

See code: @oclif/plugin-help

elasticsearch-knife mapping array INDEX

List all fields with array values

USAGE
  $ elasticsearch-knife mapping array [INDEX] --endpoint <value> [--query <value>] [--limit <value>] [--scrollSize
    <value>] [--ignoredFields <value>]

ARGUMENTS
  INDEX  The elasticsearch index name

FLAGS
  --endpoint=<value>       (required)
  --ignoredFields=<value>
  --limit=<value>
  --query=<value>
  --scrollSize=<value>     [default: 500]

DESCRIPTION
  List all fields with array values

EXAMPLES
  $ oex mapping array
  hello friend from oclif! (./src/commands/hello/index.ts)

elasticsearch-knife plugins

List installed plugins.

USAGE
  $ elasticsearch-knife plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ elasticsearch-knife plugins

See code: @oclif/plugin-plugins

elasticsearch-knife plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ elasticsearch-knife plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ elasticsearch-knife plugins add

EXAMPLES
  $ elasticsearch-knife plugins:install myplugin 

  $ elasticsearch-knife plugins:install https://github.com/someuser/someplugin

  $ elasticsearch-knife plugins:install someuser/someplugin

elasticsearch-knife plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ elasticsearch-knife plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ elasticsearch-knife plugins:inspect myplugin

elasticsearch-knife plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ elasticsearch-knife plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ elasticsearch-knife plugins add

EXAMPLES
  $ elasticsearch-knife plugins:install myplugin 

  $ elasticsearch-knife plugins:install https://github.com/someuser/someplugin

  $ elasticsearch-knife plugins:install someuser/someplugin

elasticsearch-knife plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ elasticsearch-knife plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ elasticsearch-knife plugins:link myplugin

elasticsearch-knife plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ elasticsearch-knife plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ elasticsearch-knife plugins unlink
  $ elasticsearch-knife plugins remove

elasticsearch-knife plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ elasticsearch-knife plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ elasticsearch-knife plugins unlink
  $ elasticsearch-knife plugins remove

elasticsearch-knife plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ elasticsearch-knife plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ elasticsearch-knife plugins unlink
  $ elasticsearch-knife plugins remove

elasticsearch-knife plugins update

Update installed plugins.

USAGE
  $ elasticsearch-knife plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.