Class Run

The Run step is used for invoking all command-line programs.

see: https://circleci.com/docs/configuration-reference#run

Hierarchy

Run

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

Constructors

constructor

new Run(parameters: RunParameters): Run

- Defined in src/lib/Components/Commands/exports/Native/Run.ts:21
Parameters
- parameters: RunParameters
Returns Run

Properties

parameters

parameters: RunParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

Implementation of Command.generableType
- Defined in src/lib/Components/Commands/exports/Native/Run.ts:63
Type of generable object

Returns GenerableType

name

get name(): string

Implementation of Command.name
- Defined in src/lib/Components/Commands/exports/Native/Run.ts:38
The name of the CircleCI step, which will appear in the CircleCI UI.

Returns string

Methods

addEnvVar

addEnvVar(name: string, value: string): Run

- Defined in src/lib/Components/Commands/exports/Native/Run.ts:52
Add an environment variable to the command. This will be set in plain-text via the exported config file. Consider using project-level environment variables or a context for sensitive information.
see
https://circleci.com/docs/env-vars

example
```
myCommand.addEnvVar('MY_VAR', 'my value');
```
Parameters
- name: string
- value: string
Returns Run

generate

generate(flatten?: boolean): RunCommandShape | RunCommandShorthandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/Run.ts:28
Generate Run Command shape.*

Parameters
- flatten: boolean = false
Returns RunCommandShape | RunCommandShorthandShape
The generated JSON for the Run Command.

Generated using TypeDoc