Skip to main content
Version: 0.11

Tremor cli v0.11

Tremor cli - Command Line Interface

Scope#

This document summarises the tremor cli commands.

Audience#

Tremor operators and developers

General flags and switches#

Arguments

NameSwitchKindMultipleDescription
verboseNoneswitch/flagyesSets the level of verbosity
instanceNoneswitch/flagnoInstance identifier

Commands#

Subcommands

CommandDescription
completionsGenerate shell completions to stdout. Tries to guess the shell if no subcommand is given.
serverTremor server
testTesting facilities
dbgAdvanced debugging commands
runRun tremor script or query files against stdin or a json data archive, the data will be read from STDIN or an archive and written to STDOUT.
docGenerates documention from tremor script files
apiTremor API client

completions#

Generate shell completions to stdout. Tries to guess the shell if no subcommand is given.

Subcommands

CommandDescription
guessGenerate completion based on active shell
bashGenerate bash shell completions
zshGenerate zsh shell completions
elvishGenerate elvish shell completions
fishGenerate fish shell completions
powershellGenerate powershell shell completions

completions guess#

Generate completion based on active shell

Usage

tremor completions guess

completions bash#

Generate bash shell completions

Usage

tremor completions bash

completions zsh#

Generate zsh shell completions

Usage

tremor completions zsh

completions elvish#

Generate elvish shell completions

Usage

tremor completions elvish

completions fish#

Generate fish shell completions

Usage

tremor completions fish

completions powershell#

Generate powershell shell completions

Usage

tremor completions powershell

server#

Tremor server

Subcommands

CommandDescription
runRuns the tremor server process

server run#

Runs the tremor server process

Usage

tremor server run

Arguments

NameSwitchKindMultipleDescription
artefactsNoneswitch/flagyesPaths to files containing pipelines, onramps, offramps to provision
storage-directoryNoneswitch/flagnoDirectory to cache/store runtime type information
pidNoneswitch/flagnoCaptures process id if set and stores in a file
no-apiNoneswitch/flagnoDisable the API
api-hostNoneswitch/flagnoThe host:port to listen for the API
logger-configNoneswitch/flagnolog4rs config
recursion-limitNoneswitch/flagnofunction tail-recursion stack depth limit

test#

Testing facilities

Usage

tremor test [<MODE>] [<PATH>]

Arguments

NameSwitchKindMultipleDescription
MODENoneswitch/flagnoOne of all, api, bench, command, integration, rest, or unit
PATHNoneswitch/flagnoThe root test path
REPORTNoneswitch/flagnoShould generate a test report to specified path
INCLUDESNoneswitch/flagyesOptional tags to filter test executions by
EXCLUDESNoneswitch/flagyesOptional tags to filter test executions by
QUIETNoneswitch/flagnodo not print skipped tests

dbg#

Advanced debugging commands

Arguments

NameSwitchKindMultipleDescription
no-bannerNoneswitch/flagnodo not print the banner
no-highlightNoneswitch/flagnodo not highlight output

Subcommands

CommandDescription
dotprints the .dot representation for a trickle file (you can use `
astprints the AST of the source
preprocessprints the preprocessed source
lexprints lexemes
srcprints source

dbg dot#

prints the .dot representation for a trickle file (you can use | dot -Tpng -oout.png to generate a picture)

Usage

tremor dbg dot [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
SCRIPTNoneswitch/flagnotrickle script filename

dbg ast#

prints the AST of the source

Usage

tremor dbg ast [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
exprs-onlyNoneswitch/flagnoonly prints the expressions
SCRIPTNoneswitch/flagnotremor/json/trickle script filename

dbg preprocess#

prints the preprocessed source

Usage

tremor dbg preprocess [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
SCRIPTNoneswitch/flagnotremor/json/trickle script filename

dbg lex#

prints lexemes

Usage

tremor dbg lex [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
SCRIPTNoneswitch/flagnotremor/json/trickle script filename

dbg src#

prints source

Usage

tremor dbg src [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
SCRIPTNoneswitch/flagnotremor/json/trickle script filename

run#

Run tremor script or query files against stdin or a json data archive, the data will be read from STDIN or an archive and written to STDOUT.

Usage

tremor run [<SCRIPT>]

Arguments

NameSwitchKindMultipleDescription
SCRIPTNoneswitch/flagnofilename to run the data through
interactiveNoneswitch/flagnoShould not output to consumed source / produced synthetic data or errors
prettyNoneswitch/flagnoShould not pretty print data [ when in interactive mode ]
ENCODERNoneswitch/flagnoThe codec to use for encoding the data
DECODERNoneswitch/flagnoThe codec to use for decoding the data
INFILENoneswitch/flagnoinput file
OUTFILENoneswitch/flagnooutput file
PREPROCESSORNoneswitch/flagnopreprocessor to pass data through before decoding
POSTPROCESSORNoneswitch/flagnopostprocessor to pass data through after encoding
output-portNoneswitch/flagnoselects the port to pull output

doc#

Generates documention from tremor script files

Usage

tremor doc [<DIR>] [<OUTDIR>]

Arguments

NameSwitchKindMultipleDescription
interactiveNoneswitch/flagnogenerates output to standard output
DIRNoneswitch/flagnodirectory or source to generate documents for
OUTDIRNoneswitch/flagnodirectory to generate documents into

api#

Tremor API client

Arguments

NameSwitchKindMultipleDescription
FORMATNoneswitch/flagnoSets the output format
CONFIGNoneswitch/flagnoSets a custom config file

Subcommands

CommandDescription
versionGet tremor version
targetTarget one or many tremor server instances
bindingQuery/update binding specification repository
pipelineQuery/update pipeline specification repository
onrampQuery/update onramp specification repository
offrampQuery/update offramp specification repository

api version#

Get tremor version

Usage

tremor api version

api target#

Target one or many tremor server instances

Subcommands

CommandDescription
listList registered targets
createCreate a new API target
deleteDelete an existing API target
api target list#

List registered targets

Usage

tremor api target list
api target create#

Create a new API target

Usage

tremor api target create [<TARGET_ID>] [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
TARGET_IDNoneswitch/flagnoThe unique target id for the targetted tremor servers
SOURCENoneswitch/flagnoJSON or YAML file request body
api target delete#

Delete an existing API target

Usage

tremor api target delete [<TARGET_ID>]

Arguments

NameSwitchKindMultipleDescription
TARGET_IDNoneswitch/flagnoThe unique target id for the targetted tremor servers

api binding#

Query/update binding specification repository

Subcommands

CommandDescription
listList registered binding specifications
fetchFetch a binding by artefact id
deleteDelete a binding by artefact id
createCreate and register a binding specification
instanceFetch an binding instance by artefact id and instance id
activateActivate a binding by artefact id and servant instance id
deactivateActivate a binding by artefact id and servant instance id
api binding list#

List registered binding specifications

Usage

tremor api binding list
api binding fetch#

Fetch a binding by artefact id

Usage

tremor api binding fetch [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the binding specification
api binding delete#

Delete a binding by artefact id

Usage

tremor api binding delete [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the binding specification
api binding create#

Create and register a binding specification

Usage

tremor api binding create [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
SOURCENoneswitch/flagnoJSON or YAML file request body
api binding instance#

Fetch an binding instance by artefact id and instance id

Usage

tremor api binding instance [<ARTEFACT_ID>] [<INSTANCE_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the binding specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the binding specification
api binding activate#

Activate a binding by artefact id and servant instance id

Usage

tremor api binding activate [<ARTEFACT_ID>] [<INSTANCE_ID>] [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the binding specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the binding specification
SOURCENoneswitch/flagnoJSON -r YAML file request body
api binding deactivate#

Activate a binding by artefact id and servant instance id

Usage

tremor api binding deactivate [<ARTEFACT_ID>] [<INSTANCE_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the binding specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the binding specification

api pipeline#

Query/update pipeline specification repository

Subcommands

CommandDescription
listList registered pipeline specifications
fetchFetch a pipeline by artefact id
deleteDelete a pipeline by artefact id
createCreate and register a pipeline specification
instanceFetch an pipeline instance by artefact id and instance id
api pipeline list#

List registered pipeline specifications

Usage

tremor api pipeline list
api pipeline fetch#

Fetch a pipeline by artefact id

Usage

tremor api pipeline fetch [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the pipeline specification
api pipeline delete#

Delete a pipeline by artefact id

Usage

tremor api pipeline delete [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the pipeline specification
api pipeline create#

Create and register a pipeline specification

Usage

tremor api pipeline create [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
SOURCENoneswitch/flagnoJSON or YAML file request body
api pipeline instance#

Fetch an pipeline instance by artefact id and instance id

Usage

tremor api pipeline instance [<ARTEFACT_ID>] [<INSTANCE_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the pipeline specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the pipeline specification

api onramp#

Query/update onramp specification repository

Subcommands

CommandDescription
listList registered onramp specifications
fetchFetch an onramp by artefact id
deleteDelete an onramp by artefact id
createCreate and register an onramp specification
instanceFetch an onramp instance by artefact id and instance id
api onramp list#

List registered onramp specifications

Usage

tremor api onramp list
api onramp fetch#

Fetch an onramp by artefact id

Usage

tremor api onramp fetch [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the onramp specification
api onramp delete#

Delete an onramp by artefact id

Usage

tremor api onramp delete [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the onramp specification
api onramp create#

Create and register an onramp specification

Usage

tremor api onramp create [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
SOURCENoneswitch/flagnoJSON or YAML file request body
api onramp instance#

Fetch an onramp instance by artefact id and instance id

Usage

tremor api onramp instance [<ARTEFACT_ID>] [<INSTANCE_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the onramp specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the onramp specification

api offramp#

Query/update offramp specification repository

Subcommands

CommandDescription
listList registered offramp specifications
fetchFetch an offramp by artefact id
deleteDelete an offramp by artefact id
createCreate and register an offramp specification
instanceFetch an offramp instance by artefact id and instance id
api offramp list#

List registered offramp specifications

Usage

tremor api offramp list
api offramp fetch#

Fetch an offramp by artefact id

Usage

tremor api offramp fetch [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the offramp specification
api offramp delete#

Delete an offramp by artefact id

Usage

tremor api offramp delete [<ARTEFACT_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the offramp specification
api offramp create#

Create and register an offramp specification

Usage

tremor api offramp create [<SOURCE>]

Arguments

NameSwitchKindMultipleDescription
SOURCENoneswitch/flagnoJSON or YAML file request body
api offramp instance#

Fetch an offramp instance by artefact id and instance id

Usage

tremor api offramp instance [<ARTEFACT_ID>] [<INSTANCE_ID>]

Arguments

NameSwitchKindMultipleDescription
ARTEFACT_IDNoneswitch/flagnoThe unique artefact id for the offramp specification
INSTANCE_IDNoneswitch/flagnoThe unique instance id for the offramp specification