cls-local(1)

Name

cls-local - Support for executing workloads locally in a terminal.

Synopsis

cls local [-v] [--dry-run] [--exclude-all-arcs[=<excludeAllArcs>]] [--exclude-all-tags[=<excludeAllTags>]] [--resolve-deployed-datasets [=<resolveDeployedDatasets>]] [-e=<entryPoint>] [-i=<image>] [-l=<lotId>] -n=<name> [-o=<runOptions>] [--output=<format>] [--profile=<profile>] [-r=<role>] [-s=<manifestState>] [--exclude-arc=<excludeArcNames>]…​ [--only-resource=<onlyResourceNames>]…​ [-p=<projectFiles>[, <projectFiles>…​]]…​ [-P=<providerNames>]…​ [--project-resolve=<projectResolveFiles>[, <projectResolveFiles>…​]]…​ [COMMAND]

Description

Support for executing workloads locally in a terminal.

Options

--dry-run

Do not execute underlying cdk binary.

-e, --entrypoint=<entryPoint>

Prefix this to the commands, should be the script referenced by the Dockerfile entrypoint.

--exclude-all-arcs[=<excludeAllArcs>]

Exclude all arcs from the deployment, only deploy resources and boundaries.

--exclude-all-tags[=<excludeAllTags>]

Exclude all tags from the deployment.

--exclude-arc=<excludeArcNames>

Exclude the named arc from the deployment.

-i, --image=<image>

Run commands via the supplied container image.

-l, --lot=<lotId>

The lot id of the manifest to source.

-n, --name=<name>

The arc or activity name to execute.

-o, --run-options=<runOptions>

Pass these options to the container run command. E.g. '-p=5005:5005'

--only-resource=<onlyResourceNames>

Only deploy the named resource.

--output=<format>

Print results using given format.

Values: table, json, csv, tsv (default: table)

-p, --project=<projectFiles>[,<projectFiles>…​]

The files that declare the project to be deployed, or - to read from stdin.

-P, --providers=<providerNames>

Provider substrates to target.

--profile=<profile>

aws profile

--project-resolve=<projectResolveFiles>[,<projectResolveFiles>…​]

The files that declare resources required by the main project file(s).

-r, --role=<role>

The dataset role to execute against.

--resolve-deployed-datasets[=<resolveDeployedDatasets>]

Attempt to resolve deployed datasets.

-s, --manifest-state=<manifestState>

Manifest state.

Values: complete, partial, empty, removed (default: complete)

-v, --verbose

Specify multiple -v options to increase verbosity.

For example, -v -v -v or -vvv

Commands

help

Display help information about the specified command.