https://github.com/fryuni/druidctl
A CLI for Apache Druid management.
https://github.com/fryuni/druidctl
Last synced: about 1 month ago
JSON representation
A CLI for Apache Druid management.
- Host: GitHub
- URL: https://github.com/fryuni/druidctl
- Owner: Fryuni
- Created: 2024-07-16T19:58:06.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T15:03:41.000Z (9 months ago)
- Last Synced: 2025-03-17T22:32:13.054Z (about 1 month ago)
- Language: TypeScript
- Size: 118 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# druidctl
A CLI for Apache Druid management.
[](https://oclif.io)
[](https://npmjs.org/package/druidctl)
[](https://npmjs.org/package/druidctl)
- [druidctl](#druidctl)
- [Usage](#usage)
- [Commands](#commands)
# Usage
```sh-session
$ 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-api-get-route)
- [`druidctl sql [SQL]`](#druidctl-sql-sql)
- [`druidctl supervisor list`](#druidctl-supervisor-list)
## `druidctl api get ROUTE`
Send a raw GET request to the Druid REST API
```
USAGE
$ druidctl api get ROUTE --url [--json] [-u ]
ARGUMENTS
ROUTE API route to request
GLOBAL FLAGS
-u, --user= User to authenticate as using basic auth
--json Format output as json.
--url= (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](https://github.com/Fryuni/druidctl/blob/v0.0.1-alpha.1/src/commands/api/get.ts)_
## `druidctl sql [SQL]`
Execute SQL
```
USAGE
$ druidctl sql [SQL] --url [--json] [-u ] [-f ]
ARGUMENTS
SQL SQL to execute
FLAGS
-f, --file= read SQL from a file
GLOBAL FLAGS
-u, --user= User to authenticate as using basic auth
--json Format output as json.
--url= (required) Base URL of the Druid instance
DESCRIPTION
Execute SQL
EXAMPLES
$ druidctl sql
```
_See code: [src/commands/sql.ts](https://github.com/Fryuni/druidctl/blob/v0.0.1-alpha.1/src/commands/sql.ts)_
## `druidctl supervisor list`
list supervisors
```
USAGE
$ druidctl supervisor list --url [--json] [-u ]
GLOBAL FLAGS
-u, --user= User to authenticate as using basic auth
--json Format output as json.
--url= (required) Base URL of the Druid instance
DESCRIPTION
list supervisors
EXAMPLES
$ druidctl supervisor list
```
_See code: [src/commands/supervisor/list.ts](https://github.com/Fryuni/druidctl/blob/v0.0.1-alpha.1/src/commands/supervisor/list.ts)_