redash-cli

Simple CLI to for redash.io

• Usage
• Commands

Usage

$ npm install -g redash-cli
$ redash-cli COMMAND
running command...
$ redash-cli (-v|--version|version)
redash-cli/0.3.7 darwin-x64 node-v16.15.1
$ redash-cli --help [COMMAND]
USAGE
  $ redash-cli COMMAND
...

Commands

• redash-cli dashboard:one SLUG
• redash-cli dashboard:snapshot SLUG PATH
• redash-cli help [COMMAND]
• redash-cli query:job JOBID
• redash-cli query:many
• redash-cli query:one QUERYID
• redash-cli query:snapshot QUERYID VISUALIZATIONID PATH
• redash-cli query:update QUERYID [PARAMETERS]

redash-cli dashboard:one SLUG

Returns a collection of dashboard query pngs

USAGE
  $ redash-cli dashboard:one SLUG

ARGUMENTS
  SLUG  dashboard slug

OPTIONS
  -h, --help               show CLI help
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  --json                   only output JSON response

EXAMPLE
  $ redash-cli dashboard:one my-dashboard-slug

See code: src/commands/dashboard/one.ts

redash-cli dashboard:snapshot SLUG PATH

Returns a collection of dashboard query pngs

USAGE
  $ redash-cli dashboard:snapshot SLUG PATH

ARGUMENTS
  SLUG  dashboard slug
  PATH  directory path for snapshot png

OPTIONS
  -a, --max_age=max_age    [default: 86400] max age (seconds) for cached result
  -h, --help               show CLI help
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  -x, --width=width        [default: 1200] snapshot width
  -y, --height=height      [default: 900] snapshot height
  --json                   only output JSON response

EXAMPLE
  $ redash-cli dashboard:snapshot my-dashboard-slug ./local/snapshots/directory

See code: src/commands/dashboard/snapshot.ts

redash-cli help [COMMAND]

display help for redash-cli

USAGE
  $ redash-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

redash-cli query:job JOBID

Returns queries Job status object

USAGE
  $ redash-cli query:job JOBID

ARGUMENTS
  JOBID  job id

OPTIONS
  -h, --help               show CLI help
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  --json                   only output JSON response

EXAMPLE
  $ redash-cli query:job 1234

See code: src/commands/query/job.ts

redash-cli query:many

Returns a paginated array of query objects

USAGE
  $ redash-cli query:many

OPTIONS
  -h, --help                 show CLI help
  -n, --hostname=hostname    [default: https://redash.io] redash hostname
  -p, --page=page            [default: 1] page index
  -q, --query=query          search query string
  -s, --page_size=page_size  [default: 25] page size
  -t, --token=token          api (query) token
  --json                     only output JSON response

EXAMPLE
  $ redash-cli query:many

See code: src/commands/query/many.ts

redash-cli query:one QUERYID

Returns a a single query object

USAGE
  $ redash-cli query:one QUERYID

ARGUMENTS
  QUERYID  query id

OPTIONS
  -h, --help               show CLI help
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  --json                   only output JSON response

EXAMPLE
  $ redash-cli query:one 1234

See code: src/commands/query/one.ts

redash-cli query:snapshot QUERYID VISUALIZATIONID PATH

Returns a query chart as png

USAGE
  $ redash-cli query:snapshot QUERYID VISUALIZATIONID PATH

ARGUMENTS
  QUERYID          query id
  VISUALIZATIONID  visualization id
  PATH             directory path for snapshot png

OPTIONS
  -h, --help               show CLI help
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  -x, --width=width        [default: 800] snapshot width
  -y, --height=height      [default: 600] snapshot height
  --json                   only output JSON response

EXAMPLE
  $ redash-cli query:snapshot 1234 5678 ./local/snapshots/directory

See code: src/commands/query/snapshot.ts

redash-cli query:update QUERYID [PARAMETERS]

Updates query and returns result

USAGE
  $ redash-cli query:update QUERYID [PARAMETERS]

ARGUMENTS
  QUERYID     query id
  PARAMETERS  query parameters

OPTIONS
  -h, --help               show CLI help
  -m, --max_age=max_age    [default: 0] max age of query result
  -n, --hostname=hostname  [default: https://redash.io] redash hostname
  -t, --token=token        api (query) token
  --json                   only output JSON response

EXAMPLES
  $ redash-cli query:update 1234 "{number_param:0,date_param:"2020-01-01"}"
  $ redash-cli query:update 1234 --json > output.json

See code: src/commands/query/update.ts