Skip to content

CLI

Pass launch arguments to the 10x Engine via the command-line interface.

The structure for configuring a 10x Engine instance via the command line is:

 $ tenx <bootstrap options> <pipeline> [pipeline options]

Bootstrap options specify the target pipeline (e.g., run, compile) to start, as well additional bootstrap settings (e.g., license key).

Command line arguments can configure pipeline and module settings as sub-options of the pipeline argument.

For example, to specify a bootstrap licenseKey option for a run pipeline and an elasticSearchHost input module argument, use:

$ tenx licenseKey <my-key> run elasticSearchHost acme.us-central1.gcp.cloud.es.io ...

Include Files

To load config file(s) in any of the supported formats, specify its path on disk preceded with a @ character. For example:

$ tenx @~/config.yaml @~/script.js

List Arguments

Arguments whose type is defined as list can specify multiple values on the command line.

The example below specifies two elasticSearchTargets argument values for a target Elastic input:

$ tenx run elasticSearchHost acme.us-central1.gcp.cloud.es.io elasticSearchTargets index1 elasticSearchTargets index2

Multiple Instances

Unit and modules whose allowMultiple setting is true (e.g., inputs, outputs) can configure multiple instances of each module via the command line.

The example below configures two instances of the Elastic input module to read data into the pipeline:

$ tenx run elasticSearchHost acme.us-central1.gcp.cloud.es.io ... elasticSearchHost acme.us-central2.gcp.cloud.es.io