Fryuni / druidctl

A CLI for Apache Druid management.

druidctl

A CLI for Apache Druid management.

• druidctl
• Usage
• Commands

Usage

$ npm install -g druidctl
$ druidctl COMMAND
running command...
$ druidctl (--version)
druidctl/0.0.1-alpha.1 linux-x64 node-v20.15.1
$ druidctl --help [COMMAND]
USAGE
  $ druidctl COMMAND
...

Commands

• druidctl api get ROUTE
• druidctl sql [SQL]
• druidctl supervisor list

druidctl api get ROUTE

Send a raw GET request to the Druid REST API

USAGE
  $ druidctl api get ROUTE --url <value> [--json] [-u <value>]

ARGUMENTS
  ROUTE  API route to request

GLOBAL FLAGS
  -u, --user=<value>  User to authenticate as using basic auth
      --json          Format output as json.
      --url=<value>   (required) Base URL of the Druid instance

DESCRIPTION
  Send a raw GET request to the Druid REST API

EXAMPLES
  $ druidctl api get /health

See code: src/commands/api/get.ts

druidctl sql [SQL]

Execute SQL

USAGE
  $ druidctl sql [SQL] --url <value> [--json] [-u <value>] [-f <value>]

ARGUMENTS
  SQL  SQL to execute

FLAGS
  -f, --file=<value>  read SQL from a file

GLOBAL FLAGS
  -u, --user=<value>  User to authenticate as using basic auth
      --json          Format output as json.
      --url=<value>   (required) Base URL of the Druid instance

DESCRIPTION
  Execute SQL

EXAMPLES
  $ druidctl sql

See code: src/commands/sql.ts

druidctl supervisor list

list supervisors

USAGE
  $ druidctl supervisor list --url <value> [--json] [-u <value>]

GLOBAL FLAGS
  -u, --user=<value>  User to authenticate as using basic auth
      --json          Format output as json.
      --url=<value>   (required) Base URL of the Druid instance

DESCRIPTION
  list supervisors

EXAMPLES
  $ druidctl supervisor list

See code: src/commands/supervisor/list.ts