Skip to content

Tremor tool

Tremor command line interface tool

Scope

This document summarises tremor tool commands

Audience

Tremor operators and developers

Usage

General flags and switches

Name Switch Kind Multiple Description
config c takes value yes Sets a custom config file
verbose v switch/flag yes Sets the level of verbosity
format f takes value yes Sets the output format ( json

Commands

Top level command summary

Command Description
script Tremor scripting language tool
grok Tremor support for logstash grok patterns
pipe Tremor pipeline tool
api Tremor API client

Command Details

Details for each supported command

Command: script

Tremor scripting language tool

Subcommand: run

Arguments:

Argument Required? Description
SCRIPT yes tremor script filename
DATA no JSON-per-line data log to replay

Command: grok

Tremor support for logstash grok patterns

Subcommand: run

Arguments:

Argument Required? Description
patterns no Extra patterns ( or alternative builtins if ignoring builtin patterns )
TEST_PATTERN yes The grok pattern under test for this run
DATA no line by line data log to replay, or stdin otherwise

Command: pipe

Tremor pipeline tool

Subcommand: run

Arguments:

Argument Required? Description
CONFIG yes tremor pipeline configuration
DATA no JSON-per-line data log to replay

Subcommand: dot

Arguments:

Argument Required? Description
CONFIG yes tremor pipeline configuration

Command: api

Tremor API client

Subcommand: version

Subcommand: target

Name Description
list List registered targets
create Create a new API target
delete Delete an existing API target
target list
target create

Arguments:

Argument Required? Description
TARGET_ID yes The unique target id for the targetted tremor servers
target delete

Arguments:

Argument Required? Description
TARGET_ID yes The unique target id for the targetted tremor servers

Subcommand: binding

Name Description
list List registered binding specifications
fetch Fetch a binding by artefact id
delete Delete a binding by artefact id
create Create and register a binding specification
instance Fetch an binding instance by artefact id and instance id
activate Activate a binding by artefact id and worker instance id
deactivate Activate a binding by artefact id and worker instance id
binding list
binding fetch

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the binding specification
binding delete

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the binding specification
binding create

Arguments:

Argument Required? Description
SOURCE yes JSON or YAML file request body
binding instance

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the binding specification
binding activate

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the binding specification
binding deactivate

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the binding specification

Subcommand: pipeline

Name Description
list List registered pipeline specifications
fetch Fetch a pipeline by artefact id
delete Delete a pipeline by artefact id
create Create and register a pipeline specification
instance Fetch an pipeline instance by artefact id and instance id
pipeline list
pipeline fetch

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the pipeline specification
pipeline delete

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the pipeline specification
pipeline create

Arguments:

Argument Required? Description
SOURCE no JSON or YAML file request body
pipeline instance

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the pipeline specification

Subcommand: onramp

Name Description
list List registered onramp specifications
fetch Fetch an onramp by artefact id
delete Delete an onramp by artefact id
create Create and register an onramp specification
instance Fetch an onramp instance by artefact id and instance id
onramp list
onramp fetch

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the onramp specification
onramp delete

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the onramp specification
onramp create

Arguments:

Argument Required? Description
SOURCE no JSON or YAML file request body
onramp instance

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the onramp specification

Subcommand: offramp

Name Description
list List registered offramp specifications
fetch Fetch an offramp by artefact id
delete Delete an offramp by artefact id
create Create and register an offramp specification
instance Fetch an offramp instance by artefact id and instance id
offramp list
offramp fetch

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the offramp specification
offramp delete

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the offramp specification
offramp create

Arguments:

Argument Required? Description
SOURCE no JSON or YAML file request body
offramp instance

Arguments:

Argument Required? Description
ARTEFACT_ID yes The unique artefact id for the offramp specification